Index: dialin/hd/valves.py =================================================================== diff -u -r4903294ad7ee4218a2bfc535e3ab85e93d3f1f8f -r976d426ee4ec5aee8c9d8777cf9d6a7a79778532 --- dialin/hd/valves.py (.../valves.py) (revision 4903294ad7ee4218a2bfc535e3ab85e93d3f1f8f) +++ dialin/hd/valves.py (.../valves.py) (revision 976d426ee4ec5aee8c9d8777cf9d6a7a79778532) @@ -62,7 +62,7 @@ """ \class HDValves - \brief Hemodialysis Device (HD) Dialin API sub-class for valves related commands. + @brief Hemodialysis Device (HD) Dialin API sub-class for valves related commands. """ # Valves states publish message field positions # Note the MsgFieldPosition was not used since some of the published data are S16 @@ -104,6 +104,7 @@ DGDrainPump constructor @param outer_instance: reference to the DG (outer) class. + @param logger: reference to the DG (outer) class. """ super().__init__() self.can_interface = can_interface @@ -162,6 +163,7 @@ VALVE_POSITION_A_INSERT_EJECT = 1 VALVE_POSITION_B_OPEN = 2 VALVE_POSITION_C_CLOSE = 3 + @param reset: integer - 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ reset_value = integer_to_bytearray(reset) @@ -195,6 +197,7 @@ @param direction: integer - Direction number: 0 = Clockwise 1 = Counter clockwise + @param reset: integer - 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ reset_value = integer_to_bytearray(reset) @@ -248,6 +251,7 @@ """ Constructs and sends an open/close command to the HD air trap valve + @param valve_state: air trap valve state (open or close) @returns 1 if successful, zero otherwise """