Libraries.Robots.Lego.Battery Documentation

The Battery class is an object representation of the LEGO Mindstorms EV3 Battery. It is only used to get information about the current battery usage.

Example Code

use Libraries.Robots.Lego.Battery
use Libraries.Robots.Lego.Motor

class Main
action Main
    Motor motor
    Battery battery

    motor:SetSpeed("A", 200)
    number batteryCurrent = battery:GetCurrent()
    repeat while true
        batteryCurrent = battery:GetCurrent()
        if (batteryCurrent < 0.05)
            motor:SetSpeed("A", 1000)
        else
            motor:SetSpeed("A", 200)
        end
        motor:RotateForward("A")
    end
end
end

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetCurrent()

This action gets the current (in amps) flowing from the battery.

Return

number: a number representing the current, in amps, coming from the batteries.

Example

use Libraries.Robots.Lego.Battery

Battery battery

number current = battery:GetCurrent()
if current < 0.05
    output "The electrical current coming from the batteries is: " + current
end

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetVoltage()

This action gets the total voltage (in volts) coming from the batteries. This value should be somewhere around 6 through 9.

Return

number: a number representing the total voltage, in volts, coming from the batteries.

Example

use Libraries.Robots.Lego.Battery

Battery battery

number voltage = battery:GetVoltage()
output "The voltage coming from the batteries is: " + voltage + " volts."