Index: leahi_dialin/ro/modules/levels.py =================================================================== diff -u -r3c967e5acc6286c6334d2708600e3317988f87f1 -r7ae7087e830140ab07b841b2c0ff437269a5fc2f --- leahi_dialin/ro/modules/levels.py (.../levels.py) (revision 3c967e5acc6286c6334d2708600e3317988f87f1) +++ leahi_dialin/ro/modules/levels.py (.../levels.py) (revision 7ae7087e830140ab07b841b2c0ff437269a5fc2f) @@ -28,7 +28,7 @@ class ROLevels(AbstractSubSystem): """ - Reverse Osmosis (RO) Dialin API sub-class for levels related commands. + Dialin API sub-class for levels related commands. """ def __init__(self, can_interface, logger: Logger): @@ -42,7 +42,7 @@ self.can_interface = can_interface self.logger = logger - self.floater = 0 + self.p25_level = 0 self.ro_levels_timestamp = 0 if self.can_interface is not None: @@ -51,22 +51,22 @@ self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_levels_sync) @publish(["ro_levels_timestamp", - "floater",]) + "p25_level",]) def _handler_levels_sync(self, message, timestamp=0.0): """ Handles published levels message @param message: published levels data message @returns none """ - self.floater = struct.unpack('i', bytearray( + self.p25_level = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.ro_levels_timestamp = timestamp def cmd_levels_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ - Constructs and sends broadcast time interval. + Constructs and sends RO level broadcast time interval override. Constraints: Must be logged into RO. Given interval must be non-zero and a multiple of the RO general task interval (50 ms). @@ -86,7 +86,7 @@ message_id=MsgIds.MSG_ID_RO_LEVELS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, payload=payload) - self.logger.debug("Sending {} ms publish interval to the Levels module".format(ms)) + self.logger.debug("Sending {} ms publish interval to the RO Levels module".format(ms)) # Send message received_message = self.can_interface.send(message) @@ -100,12 +100,11 @@ def cmd_level_status_override(self, level_sensor: int, status: int, reset: int = NO_RESET) -> int: """ - Constructs and sends level status override command - Must be logged into RO + Constructs and sends level status override command. + Must be logged into RO. - - @param level_sensor the level sensor to override its value - @param status the status value to override + @param level_sensor: integer - the level sensor to override its value + @param status: integer - the status value to override @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """