Index: .gitignore =================================================================== diff -u -r9f44c02ff3f40812ab9fd7f9c7346f649a114c19 -rc3153b8411388a9318d827ae42e830627cebc220 --- .gitignore (.../.gitignore) (revision 9f44c02ff3f40812ab9fd7f9c7346f649a114c19) +++ .gitignore (.../.gitignore) (revision c3153b8411388a9318d827ae42e830627cebc220) @@ -1,31 +1,30 @@ # ignore folders __pycache__ -document/html/ -document/latex/ -.idea/ venv/ -.eggs/ -.cache tags tags.* html/ *.log -dialin_pkg_diality.egg-info/ -dist/ -build/ -dialin.egg-info/ -README.pdf -docs/build -docs/source/dialin.dg.rst -docs/source/dialin.hd.rst -docs/source/dialin.protocols.rst -docs/source/dialin.rst -docs/source/dialin.utils.rst -docs/source/dialin.squish.rst -docs/source/modules.rst -docs/source/dialin.common.rst *.swp testsuites squishtesting *.pyc *.*~ + +# Docs +docs/build +docs/source/ +document/html/ +document/latex/ +README.pdf + +# Distribution / Build data +.eggs/ +.cache +dist/ +build/ +leahi_dialin.egg*/ + +# Editors +.idea/ +.vscode/ \ No newline at end of file Index: leahi_dialin/common/override_templates.py =================================================================== diff -u -rfcb1efdc00c4679d0a3233c624d088de3a7fcf28 -rc3153b8411388a9318d827ae42e830627cebc220 --- leahi_dialin/common/override_templates.py (.../override_templates.py) (revision fcb1efdc00c4679d0a3233c624d088de3a7fcf28) +++ leahi_dialin/common/override_templates.py (.../override_templates.py) (revision c3153b8411388a9318d827ae42e830627cebc220) @@ -25,7 +25,8 @@ from ..utils.conversions import integer_to_bytearray -def cmd_generic_broadcast_interval_override(ms: int, +def cmd_generic_broadcast_interval_override(*, + ms: int, reset: int, msg_id: MsgIds, channel_id: DenaliChannels, @@ -55,11 +56,46 @@ ms_byte_array = integer_to_bytearray(ms) payload = reset_byte_array + ms_byte_array + return cmd_generic_override( + payload = payload, + channel_id = channel_id, + msg_id = msg_id, + entity_name = f'{module_name} broadcast interval', + override_text = str(ms) + " ms: ", + logger = logger, + can_interface = can_interface + ) + + +def cmd_generic_override(*, + payload: bytearray, + reset: int, + msg_id: MsgIds, + channel_id: DenaliChannels, + entity_name: str, + override_text: str, + logger: Logger, + can_interface) -> int: + """ + Constructs and sends an override command + Constraints: + Must be logged into the corresponding Module. + + @param ms: integer - interval (in ms) to override with + @param reset: integer - 1 to reset a previous override, 0 to override + @param msg_id: MsgIds - The override's msg id + @param channel_id: DenaliChannels - The override's channel id + @param module_name: str - The module's name to put into the debug prints + @param logger: str - The logger for printing debug and error messages + @param can_interface: The can_interface + @return: 1 if successful, zero otherwise + """ + message = DenaliMessage.build_message(channel_id=channel_id, message_id=msg_id.value, payload=payload) - logger.debug(f"override {module_name} broadcast interval") + logger.debug(f"override {entity_name} value") # Send message received_message = can_interface.send(message) @@ -69,8 +105,8 @@ if reset == RESET: str_res = "reset back to normal: " else: - str_res = str(ms) + " ms: " - logger.debug(f"{module_name} data broadcast interval overridden to " + str_res + + str_res = override_text + logger.debug(f"{entity_name} is overridden to " + str_res + str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) # response payload is OK or not OK return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] Index: leahi_dialin/td/modules/pressure_sensors.py =================================================================== diff -u -rc8f8cbb3230e40988847f33e9701714939462c93 -rc3153b8411388a9318d827ae42e830627cebc220 --- leahi_dialin/td/modules/pressure_sensors.py (.../pressure_sensors.py) (revision c8f8cbb3230e40988847f33e9701714939462c93) +++ leahi_dialin/td/modules/pressure_sensors.py (.../pressure_sensors.py) (revision c3153b8411388a9318d827ae42e830627cebc220) @@ -16,12 +16,12 @@ import struct from logging import Logger -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import RESET, NO_RESET from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions from leahi_dialin.common.td_defs import TDPressureSensorNames, TDPressureSensorAttributes -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels +from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray @@ -127,6 +127,7 @@ self.td_pressure_sensors[TDPressureSensorNames.H23_PRES.name][TDPressureSensorAttributes.PRES.name] = baro[0] self.td_pressure_timestamp = timestamp + def cmd_pressure_sensor_override(self, sensor: int, pressure: float, reset: int = NO_RESET) -> int: """ Constructs and sends the measured pressure sensor override command @@ -140,34 +141,53 @@ @return: 1 if successful, zero otherwise """ + sensor_name = TDPressureSensorNames(sensor).name.split('_')[0] + rst = integer_to_bytearray(reset) sen = integer_to_bytearray(sensor) prs = float_to_bytearray(pressure) payload = rst + prs + sen - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_PRESSURE_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_PRESSURE_OVERRIDE_REQUEST, + entity_name = f'{sensor_name} pressure', + override_text = str(prs) + " mmHg. ", + logger = self.logger, + can_interface = self.can_interface + ) - self.logger.debug("override pressure sensor") - # Send message - received_message = self.can_interface.send(message) + def cmd_tmp_sensor_override(self, pressure: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends the tmp sensor override command + . + Constraints: + Must be logged into TD. - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal. " - else: - str_res = str(prs) + " mmHg. " - self.logger.debug("pressure (measured)) overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False + @param pressure: float - measured pressure (in mmHg) to override with + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + """ + rst = integer_to_bytearray(reset) + prs = float_to_bytearray(pressure) + payload = rst + prs + + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_TMP_PRESSURE_OVERRIDE_REQUEST, + entity_name = 'TMP pressure', + override_text = str(prs) + " mmHg. ", + logger = self.logger, + can_interface = self.can_interface + ) + + def cmd_pressure_sensors_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the measured pressure sensors broadcast interval override command @@ -180,33 +200,11 @@ @return: 1 if successful, zero otherwise """ - if not check_broadcast_interval_override_ms(ms): - return False - - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_PRESSURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override pressure sensors broadcast interval") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # self.logger.debug(received_message) - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(ms) + " ms: " - self.logger.debug("Pressure sensors broadcast interval overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False \ No newline at end of file + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_PRESSURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD pressure sensors', + logger = self.logger, + can_interface = self.can_interface)