"""
Service Identifier (SID) data parameter implementation.
.. note:: :ref:`Service Identifiers <knowledge-base-sid>` values and their meanings are defined by ISO 14229-1
and SAE J1979 standards.
"""
__all__ = ["RequestSID", "ResponseSID", "POSSIBLE_REQUEST_SIDS", "POSSIBLE_RESPONSE_SIDS", "UnrecognizedSIDWarning"]
from warnings import warn
from aenum import unique
from uds.utilities import RawByte, RawBytesSet, ByteEnum, ValidatedEnum, ExtendableEnum
# reserved SID values
_REQUEST_SIDS_DEFINED_BY_SAEJ1979 = set(range(0x01, 0x10))
_RESPONSE_SIDS_DEFINED_BY_SAEJ1979 = set(range(0x41, 0x50))
_REQUEST_SIDS_DEFINED_BY_ISO_14229 = set(range(0x10, 0x3F)).union(set(range(0x83, 0x89)), set(range(0xBA, 0xBF)))
_RESPONSE_SIDS_DEFINED_BY_ISO_14229 = set(range(0x50, 0x80)).union(set(range(0xC3, 0xC9)), set(range(0xFA, 0xFF)))
# all supported SID values according to UDS
POSSIBLE_REQUEST_SIDS: RawBytesSet = _REQUEST_SIDS_DEFINED_BY_SAEJ1979.union(_REQUEST_SIDS_DEFINED_BY_ISO_14229)
"""Set with all possible values of Request SID data parameter according to SAE J1979 and ISO 14229 standards."""
POSSIBLE_RESPONSE_SIDS: RawBytesSet = _RESPONSE_SIDS_DEFINED_BY_SAEJ1979.union(_RESPONSE_SIDS_DEFINED_BY_ISO_14229)
"""Set with all possible values of Response SID data parameter according to SAE J1979 and ISO 14229 standards."""
[docs]class UnrecognizedSIDWarning(Warning):
"""
Warning about SID value that is legit but not recognized by the package.
.. note:: If you want to register a SID value, you need to define members (for this SID) manually using
:meth:`~uds.utilities.enums.ExtendableEnum.add_member` method
(on :class:`~uds.message.service_identifiers.RequestSID` and
:class:`~uds.message.service_identifiers.ResponseSID` classes).
You can also create feature request in the UDS project
`issues management system <https://github.com/mdabrowski1990/uds/issues/new/choose>`_ to register
a SID value (for which this warning was raised).
"""
[docs]@unique
class RequestSID(ByteEnum, ValidatedEnum, ExtendableEnum):
"""
Request Service Identifier values.
.. note:: Request :ref:`SID <knowledge-base-sid>` is always the first payload byte of all request message.
"""
[docs] @classmethod
def is_request_sid(cls, value: RawByte) -> bool:
"""
Check whether given value is Service Identifier (SID).
:param value: Value to check.
:return: True if value is valid SID, else False.
"""
if cls.is_member(value):
return True
if value in POSSIBLE_REQUEST_SIDS:
warn(message=f"SID 0x{value:X} is not recognized by this version of the package.",
category=UnrecognizedSIDWarning)
return True
return False
# Diagnostic and communication management - more information in ISO 14229-1:2020, chapter 10
DiagnosticSessionControl = 0x10 # noqa: F841
ECUReset = 0x11 # noqa: F841
SecurityAccess = 0x27 # noqa: F841
CommunicationControl = 0x28 # noqa: F841
Authentication = 0x29 # noqa: F841
TesterPresent = 0x3E # noqa: F841
ControlDTCSetting = 0x85 # noqa: F841
ResponseOnEvent = 0x86 # noqa: F841
LinkControl = 0x87 # noqa: F841
# Data transmission - more information in ISO 14229-1:2020, chapter 11
ReadDataByIdentifier = 0x22 # noqa: F841
ReadMemoryByAddress = 0x23 # noqa: F841
ReadScalingDataByIdentifier = 0x24 # noqa: F841
ReadDataByPeriodicIdentifier = 0x2A # noqa: F841
DynamicallyDefineDataIdentifier = 0x2C # noqa: F841
WriteDataByIdentifier = 0x2E # noqa: F841
WriteMemoryByAddress = 0x3D # noqa: F841
# Stored data transmission - more information in ISO 14229-1:2020, chapter 12
ClearDiagnosticInformation = 0x14 # noqa: F841
ReadDTCInformation = 0x19 # noqa: F841
# InputOutput control - more information in ISO 14229-1:2020, chapter 13
InputOutputControlByIdentifier = 0x2F # noqa: F841
# Routine - more information in ISO 14229-1:2020, chapter 14
RoutineControl = 0x31 # noqa: F841
# Upload download - more information in ISO 14229-1:2020, chapter 15
RequestDownload = 0x34 # noqa: F841
RequestUpload = 0x35 # noqa: F841
TransferData = 0x36 # noqa: F841
RequestTransferExit = 0x37 # noqa: F841
RequestFileTransfer = 0x38 # noqa: F841
SecuredDataTransmission = 0x84 # noqa: F841
[docs]@unique
class ResponseSID(ByteEnum, ValidatedEnum, ExtendableEnum):
"""
Response Service Identifier values.
.. note:: Response :ref:`SID <knowledge-base-sid>` is always the first payload byte of all request message.
.. warning:: This enum contains multiple members (for all the services as
:class:`~uds.message.service_identifiers.RequestSID`), but most of them are dynamically (implicitly) added and
invisible in the documentation.
"""
[docs] @classmethod
def is_response_sid(cls, value: RawByte) -> bool:
"""
Check whether given value is Response Service Identifier (RSID).
:param value: Value to check.
:return: True if value is valid RSID, else False.
"""
if cls.is_member(value):
return True
if value in POSSIBLE_RESPONSE_SIDS:
warn(message=f"RSID 0x{value:X} is not recognized by this version of the package",
category=UnrecognizedSIDWarning)
return True
return False
NegativeResponse = 0x7F # noqa: F841
# extend 'ResponseSID' with members that were defined in RequestSID
for request_sid_member in RequestSID: # type: ignore
ResponseSID.add_member(request_sid_member.name, request_sid_member.value + 0x40)
# TODO: add aliases