Temperature¶

class brainstem.entity.Temperature(module, index)[source]¶

Provide interface to temperature sensor.

This entitiy is only available on certain modules, and provides a temperature reading in microcelsius.

getValue()[source]¶

Get the current temperature in micro-C.

Returns:

value: The temperature in micro-C (uC) error: Non-zero BrainStem error code on failure.

Return type:

Result (object)

getValueMax()[source]¶

Get the module’s maximum temperature in micro-C since the last power cycle.

Returns:

value: The maximum temperature in micro-C (uC) error: Non-zero BrainStem error code on failure.

Return type:

Result (object)

getValueMin()[source]¶

Get the module’s minimum temperature in micro-C since the last power cycle.

Returns:

value: The minimum temperature in micro-C (uC) error: Non-zero BrainStem error code on failure.

Return type:

Result (object)

reset()[source]¶

Get the module’s maximum temperature in micro-C since the last power cycle.

Returns:

value: The maximum temperature in micro-C (uC) error: Non-zero BrainStem error code on failure.

Return type:

Result (object)

resetEntityToFactoryDefaults()[source]¶

Resets the TemperatureClass Entity to it factory default configuration.

Returns (int):
Non-zero BrainStem error code on failure.