Index: dialin/dg/drain_pump.py =================================================================== diff -u -rcc425128f399de5414b0aee1942986653ca42c92 -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/drain_pump.py (.../drain_pump.py) (revision cc425128f399de5414b0aee1942986653ca42c92) +++ dialin/dg/drain_pump.py (.../drain_pump.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -81,7 +81,7 @@ """ return self.drain_pump_state - def gete_drain_pump_current_rpm(self): + def get_drain_pump_current_rpm(self): """ Gets the drain pump current RPM @@ -118,8 +118,8 @@ Constraints: Must be logged into DG. - @param speed: integer - speed set point (in RPM) to override with - @param reset: integer - 1 to reset a previous override, 0 to override + @param speed: (int) speed set point (in RPM) to override with + @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ @@ -158,8 +158,8 @@ Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override + @param ms: (int) interval (in ms) to override with + @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ Index: dialin/dg/fans.py =================================================================== diff -u -rcc425128f399de5414b0aee1942986653ca42c92 -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/fans.py (.../fans.py) (revision cc425128f399de5414b0aee1942986653ca42c92) +++ dialin/dg/fans.py (.../fans.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -144,8 +144,8 @@ Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override + @param ms: (int) interval (in ms) to override with + @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ Index: dialin/dg/heat_disinfection.py =================================================================== diff -u -r94128c59d96218d3e1b3441f9e8cf9b6d77a4754 -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/heat_disinfection.py (.../heat_disinfection.py) (revision 94128c59d96218d3e1b3441f9e8cf9b6d77a4754) +++ dialin/dg/heat_disinfection.py (.../heat_disinfection.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -88,7 +88,7 @@ """ Constructs and sends the start/stop DG heat disinfection command - @param start: boolean - True = start heat disinfection, False = stop heat disinfection. + @param start: (bool) True = start heat disinfection, False = stop heat disinfection. @return: non-zero integer if successful, False otherwise """ # 1 is to start Index: dialin/dg/heaters.py =================================================================== diff -u -r1a2a1c42b76fc29d49ec7ebddbcead6afaccfd26 -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/heaters.py (.../heaters.py) (revision 1a2a1c42b76fc29d49ec7ebddbcead6afaccfd26) +++ dialin/dg/heaters.py (.../heaters.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -107,7 +107,7 @@ Constraints: A target temperature for primary heater between 10 and 90 deg C must have been given to DG previously. - @param state: start/stop state of the primary heater. The default is stop. + @param state: (int) start/stop state of the primary heater. The default is stop. @returns none """ if state == HeatersStartStop.START.name: @@ -130,7 +130,7 @@ Constraints: A target temperature for trimmer heater between 10 and 90 deg C must have been given to DG previously. - @param state: start/stop state of the trimmer heater. The default is stop. + @param state: (int) start/stop state of the trimmer heater. The default is stop. @returns none """ if state == HeatersStartStop.START.name: @@ -151,8 +151,8 @@ """ Constructs and sends primary and trimmer heater target temperature - @param pirmary_target_temp: Primary heater target temperature - @param trimmer_target_temp: Trimmer heater target temperature + @param pirmary_target_temp: (float) Primary heater target temperature + @param trimmer_target_temp: (float) Trimmer heater target temperature @returns none """ primary_target = float_to_bytearray(primary_target_temp) @@ -172,8 +172,8 @@ Must be logged into DG. Given interval must be non-zero and a multiple of the DG general task interval (50 ms). - @param ms: Publish time interval in ms - @param reset: integer - 1 to reset a previous override, 0 to override + @param ms: (int) Publish time interval in ms + @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ resetValue = integer_to_bytearray(reset) Index: dialin/dg/temperature_sensors.py =================================================================== diff -u -rd800c4b9c903712b1081a85f9f22b00ab952e91d -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/temperature_sensors.py (.../temperature_sensors.py) (revision d800c4b9c903712b1081a85f9f22b00ab952e91d) +++ dialin/dg/temperature_sensors.py (.../temperature_sensors.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -175,8 +175,8 @@ Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). - @param ms: Publish time interval in ms - @param reset: integer - 1 to reset a previous override, 0 to override + @param ms: (int) Publish time interval in ms + @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ reset_value = integer_to_bytearray(reset) @@ -208,7 +208,7 @@ @param sensor_index : (int) Index of the sensor @param sensor_value: (float) Value of the sensor to override - @param reset: whether to reset the override value. The default is NO_RESET + @param reset: (int) whether to reset the override value. The default is NO_RESET @returns 1 if successful, zero otherwise \details temperature sensor indexes: \n Index: dialin/dg/thermistors.py =================================================================== diff -u -rcc425128f399de5414b0aee1942986653ca42c92 -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/thermistors.py (.../thermistors.py) (revision cc425128f399de5414b0aee1942986653ca42c92) +++ dialin/dg/thermistors.py (.../thermistors.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -46,6 +46,7 @@ """ Gets a thermistor's value + @param: thermistor: (int) thermistor index @return: The temperature of a thermistor """ return self.thermistors[thermistor] @@ -75,7 +76,8 @@ Constraints: Must be logged into DG. - @param thermistor: integer - thermistor index + @param thermistor: (int) thermistor index + @param state: (int) start/stop state of the primary heater. The default is stop. @param value: float the temperature to be set """ reset_value = integer_to_bytearray(reset) @@ -104,8 +106,8 @@ Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override + @param ms: (int) interval (in ms) to override with + @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) Index: dialin/dg/uv_reactors.py =================================================================== diff -u -rcc425128f399de5414b0aee1942986653ca42c92 -re851e75aa1d8f801324442b0cb034ba3e82325c9 --- dialin/dg/uv_reactors.py (.../uv_reactors.py) (revision cc425128f399de5414b0aee1942986653ca42c92) +++ dialin/dg/uv_reactors.py (.../uv_reactors.py) (revision e851e75aa1d8f801324442b0cb034ba3e82325c9) @@ -118,8 +118,8 @@ Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override + @param ms: (int) interval (in ms) to override with + @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ @@ -158,8 +158,9 @@ Constraints: Must be logged into DG. - @param reactor: integer - UV reactor index - @param health: integer - health to be set ot + @param reactor: (int) UV reactor index + @param health: (int) 0 for unhealthy and 1 for healthy + @param reset: (int) 0 for no reset and 1 for reset """ reset_value = integer_to_bytearray(reset) rctr = integer_to_bytearray(reactor) @@ -184,7 +185,8 @@ """ Constructs and sends a start/stop command to the DG inlet UV reactor - \returns 1 if successful, zero otherwise + @param: state: (int) the state of the inlet UV reactor. 0 for Off and 1 for On. + @return: 1 if successful, zero otherwise """ if state == ReactorsStates.UV_REACTOR_STATE_ON.name: payload = integer_to_bytearray(1) @@ -212,7 +214,8 @@ """ Constructs and sends a start/stop command to the DG outlet UV reactor - \returns 1 if successful, zero otherwise + @param: state: (int) the state of the outlet UV reactor. 0 for Off and 1 for On. + @return: 1 if successful, zero otherwise """ if state == ReactorsStates.UV_REACTOR_STATE_ON: payload = integer_to_bytearray(1)