Index: dialin/dg/drain_pump.py =================================================================== diff -u -rca7f6eff65d988c19ccce8cde5efd1ef537e2095 -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/drain_pump.py (.../drain_pump.py) (revision ca7f6eff65d988c19ccce8cde5efd1ef537e2095) +++ dialin/dg/drain_pump.py (.../drain_pump.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -93,6 +93,8 @@ def cmd_drain_pump_speed_set_point_override(self, speed, reset=NO_RESET): """ Constructs and sends the drain pump speed set point override command + 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 @@ -130,7 +132,10 @@ def cmd_drain_pump_data_broadcast_interval_override(self, ms, reset=NO_RESET): """ - Constructs and sends the drain pump speed set point override command + Constructs and sends the drain pump speed set point override command. + Constraints: + 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 Index: dialin/dg/hd_proxy.py =================================================================== diff -u -rca7f6eff65d988c19ccce8cde5efd1ef537e2095 -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/hd_proxy.py (.../hd_proxy.py) (revision ca7f6eff65d988c19ccce8cde5efd1ef537e2095) +++ dialin/dg/hd_proxy.py (.../hd_proxy.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -47,9 +47,12 @@ def cmd_switch_reservoirs(self, reservoirID=RESERVOIR1): """ - Constructs and sends the switch reservoirs command + Constructs and sends the switch reservoirs command. + Constraints: + DG must be in re-circulate mode. + Given reservoirID must be in the reservoir list below. - @param res: unsigned int - reservoir to set as active (HD will draw from this reservoir). + @param reservoirID: unsigned int - reservoir to set as active (HD will draw from this reservoir). @return: 1 if successful, zero otherwise \details Reservoir IDs: \n @@ -79,7 +82,10 @@ def cmd_fill(self, volume=1500): """ - Constructs and sends the fill command + Constructs and sends the fill command. + Constraints: + DG must be in re-circulate water state of re-circulate mode. + Given fill to volume must be between 0 and 1950 mL. @param volume: unsigned int - volume (in mL) to fill inactive reservoir to. @return: 1 if successful, zero otherwise @@ -107,7 +113,10 @@ def cmd_drain(self, volume=200): """ - Constructs and sends the drain command + Constructs and sends the drain command. + Constraints: + DG must be in re-circulate mode. + Given drain to volume must be between 0 and 1950 mL. @param volume: unsigned int - volume (in mL) to drain the inactive reservoir to. @return: 1 if successful, zero otherwise @@ -136,6 +145,9 @@ def cmd_start_stop_dg(self, start=True): """ Constructs and sends the start/stop DG command + Constraints: + DG must be in idle state of standby mode if start command given. + DG must be in re-circulate mode if stop command given. @param start: boolean - True = start DG, False = stop DG. @return: 1 if successful, zero otherwise Index: dialin/dg/heaters.py =================================================================== diff -u -r414ee5c06661993d4e847b7a61067c1718340cbf -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/heaters.py (.../heaters.py) (revision 414ee5c06661993d4e847b7a61067c1718340cbf) +++ dialin/dg/heaters.py (.../heaters.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -73,6 +73,8 @@ def cmd_start_primary_heater(self): """ Constructs and sends start primary heater command + Constraints: + A target temperature for primary heater between 10 and 90 deg C must have been given to DG previously. @returns none """ @@ -102,6 +104,8 @@ def cmd_start_trimmer_heater(self): """ Constructs and sends start trimmer heater command + Constraints: + A target temperature for trimmer heater between 10 and 90 deg C must have been given to DG previously. @returns none """ @@ -146,7 +150,10 @@ def cmd_heaters_broadcast_interval_override(self, ms, reset=NO_RESET): """ - Constructs and sends broadcast time interval + Constructs and sends broadcast time interval. + Constraints: + 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 Index: dialin/dg/load_cells.py =================================================================== diff -u -rae1e423f7cf68432e1e3daf01b50a162de4563e4 -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/load_cells.py (.../load_cells.py) (revision ae1e423f7cf68432e1e3daf01b50a162de4563e4) +++ dialin/dg/load_cells.py (.../load_cells.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -105,6 +105,9 @@ def cmd_load_cell_override(self, grams, sensor, reset=NO_RESET): """ Constructs and sends the load cell override command + Constraints: + Must be logged into DG. + Given sensor must be one of the sensors listed below. @param grams: float - weight (in grams) to override sensor with @param sensor: unsigned int - sensor ID @@ -143,6 +146,9 @@ def cmd_load_cell_data_broadcast_interval_override(self, ms, reset=NO_RESET): """ Constructs and sends the load cell data broadcast interval override command + Constraints: + 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 Index: dialin/dg/pressures.py =================================================================== diff -u -rca7f6eff65d988c19ccce8cde5efd1ef537e2095 -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/pressures.py (.../pressures.py) (revision ca7f6eff65d988c19ccce8cde5efd1ef537e2095) +++ dialin/dg/pressures.py (.../pressures.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -110,7 +110,10 @@ def cmd_pressure_override(self, pressure, sensor, reset=NO_RESET): """ - Constructs and sends the pressure override command + Constructs and sends the pressure override command. + Constraints: + Must be logged into DG. + Given sensor must be one of the sensors listed below. @param pressure: unsigned int - pressure (in PSI) @param sensor: unsigned int - sensor ID @@ -148,7 +151,10 @@ def cmd_pressure_broadcast_interval_override(self, ms, reset=NO_RESET): """ - Constructs and sends the pressure override command + Constructs and sends the pressure override command. + Constraints: + Must be logged into DG. + Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). @param ms: unsigned int - broadcast interval (in ms) @param reset: integer - 1 to reset a previous override, 0 to override Index: dialin/dg/ro_pump.py =================================================================== diff -u -r5d58d1eeb80237a7cafbb31bc800cb29e19615e0 -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/ro_pump.py (.../ro_pump.py) (revision 5d58d1eeb80237a7cafbb31bc800cb29e19615e0) +++ dialin/dg/ro_pump.py (.../ro_pump.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -110,7 +110,9 @@ def cmd_ro_pump_set_point_override(self, pressure, reset=NO_RESET): """ - Constructs and sends the RO pump set point override command + Constructs and sends the RO pump set point override command. + Constraints: + Must be logged into DG. @param pressure: integer - pressure set point (in PSI) to override with @param reset: integer - 1 to reset a previous override, 0 to override @@ -148,7 +150,9 @@ def cmd_ro_flow_rate_override(self, flow, reset=NO_RESET): """ - Constructs and sends the RO rate override command + Constructs and sends the RO rate override command. + Constraints: + Must be logged into DG. @param flow: float - flow rate (in L/min) to override with @param reset: integer - 1 to reset a previous override, 0 to override @@ -187,6 +191,9 @@ def cmd_ro_pump_data_broadcast_interval_override(self, ms, reset=NO_RESET): """ Constructs and sends the RO pump set point override command + Constraints: + 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 - time interval (in ms) to broadcast RO pump data @param reset: integer - 1 to reset a previous override, 0 to override Index: dialin/dg/temperature_sensors.py =================================================================== diff -u -r414ee5c06661993d4e847b7a61067c1718340cbf -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/temperature_sensors.py (.../temperature_sensors.py) (revision 414ee5c06661993d4e847b7a61067c1718340cbf) +++ dialin/dg/temperature_sensors.py (.../temperature_sensors.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -147,7 +147,10 @@ def cmd_temperature_sensors_broadcast_interval_override(self, ms, reset=NO_RESET): """ - Constructs and sends broadcast time interval + Constructs and sends broadcast time interval. + Constraints: + 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 @@ -175,11 +178,28 @@ def cmd_temperature_sensors_override_value(self, sensor_index, sensor_value, reset=NO_RESET): """ - Constructs and sends the value override of a temperature sensor + Constructs and sends the value override of a temperature sensor. + Constraints: + Must be logged into DG. + Given sensor_index must be one of the sensors listed below. @param sensor_index : Index of the sensor - @param sensor_value: Value of the sensor to be overriden + @param sensor_value: Value of the sensor to override @returns 1 if successful, zero otherwise + + \details temperature sensor indexes: \n + 0 = Primary Heater Inlet + 1 = Primary Heater Outlet + 2 = Conductivity Sensor 1 + 3 = Conductivity Sensor 2 + 4 = Dialysate (Redundant) + 5 = Dialysate + 6 = Primary Heater Thermocouple + 7 = Trimmer Heater Thermocouple + 8 = Primary Heater Cold Junction + 9 = Trimmer Heater Cold Junction + 10= Primary Heater Internal + 11= Trimmer Heater Internal """ rst = integer_to_bytearray(reset) value = float_to_bytearray(sensor_value) Index: dialin/dg/valves.py =================================================================== diff -u -r9858b03b175512995a5a3ef0d1ea8dc64b96b7dc -r3995adb7a16b5b7569582ba781685ca75f9af49f --- dialin/dg/valves.py (.../valves.py) (revision 9858b03b175512995a5a3ef0d1ea8dc64b96b7dc) +++ dialin/dg/valves.py (.../valves.py) (revision 3995adb7a16b5b7569582ba781685ca75f9af49f) @@ -176,7 +176,10 @@ def cmd_valve_override(self, state, valve, reset=NO_RESET): """ - Constructs and sends the valve state override command + Constructs and sends the valve state override command. + Constraints: + Must be logged into DG. + Given valve ID must be one of the valve IDs listed below. @param state: bool - valve state @param valve: unsigned int - valve ID @@ -223,7 +226,10 @@ def cmd_valve_broadcast_interval_override(self, ms, reset=NO_RESET): """ - Constructs and sends the valve state override command + Constructs and sends the valve state override command. + Constraints: + Must be logged into DG. + Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). @param ms: unsigned int - broadcast interval (in ms) @param reset: integer - 1 to reset a previous override, 0 to override