com.github.sdnwiselab.sdnwise.node.Battery Maven / Gradle / Ivy

Go to download
/* 
 * Copyright (C) 2015 SDN-WISE
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.github.sdnwiselab.sdnwise.node;

/**
 * This class simulates the behavior of a Battery of a simulated Wireless 
 * Sensor Node. The values are calculated considering the datasheet of a real
 * sensor node.
 * 
 * @author Sebastiano Milardo
 */
public class Battery {

    private final static double maxLevel = 8640000; //mC = 2 AAA batteries
    private final static double keepAlive = 6.8; //mC spent every 1 s
    private final static double transmitRadio = 0.0027; // how many mC to send 1byte
    private final static double receiveRadio = 0.00094; // how many mC to receive 1byte
    private double batteryLevel;

    /**
     * Initialize a new Battery object. The battery level is set to maxLevel.
     */
    
    public Battery() {
        this.batteryLevel = Battery.maxLevel;
    }

    /**
     * Getter for the battery level of the Battery.
     * 
     * @return the battery level of the node as a double. Can't be negative.
     */
    
    public double getBatteryLevel() {
        return this.batteryLevel;
    }

    /**
     * Setter for the battery level of the Battery.
     * 
     * @param batteryLevel the battery level. If negative, the battery level 
     * is set to 0.
     */
    
    public void setBatteryLevel(double batteryLevel) {
        if (batteryLevel >= 0){
            this.batteryLevel = batteryLevel;
        } else {
            this.batteryLevel = 0;
        }
    }

    /**
     * Simulates the battery consumption for sending nByte bytes.
     * 
     * @param nBytes the number of bytes sent over the radio
     * @return the Battery object
     */
    
    public Battery transmitRadio(int nBytes) {
        double new_val = this.batteryLevel - Battery.transmitRadio * nBytes;
        this.setBatteryLevel(new_val);
        return this;
    }

    /**
     * Simulates the battery consumption for receiving nByte bytes.
     * 
     * @param nBytes the number of bytes received over the radio
     * @return the Battery object
     */
    
    public Battery receiveRadio(int nBytes) {
        double new_val = this.batteryLevel - Battery.receiveRadio * nBytes;
        this.setBatteryLevel(new_val);
        return this;
    }

    /**
     * Simulates the battery consumption for staying alive for mSeconds seconds.
     * 
     * @param nSeconds the number of seconds the node is turned on.
     * @return the Battery object
     */
    
    public Battery keepAlive(int nSeconds) {
        double new_val = this.batteryLevel - Battery.keepAlive * nSeconds;
        this.setBatteryLevel(new_val);
        return this;
    }

    /**
     * Getter for the battery level as a percent of the maxLevel.
     * 
     * @return the Battery level in the range [0-255].
     */
    
    public int getBatteryPercent() {
        if (Battery.maxLevel != 0) {
            return (int) ((this.batteryLevel / Battery.maxLevel) * 255);
        } else {
            return 0;
        }
    }
}