def test_make_dict(self):
m = IOMasks('aaa', 'bbb') # Correct syntax
self.assertEqual(m.get_dict(), {'aaa': True, 'bbb': True})
m = IOMasks('aaa', 'bbb', ccc=True, ddd=False) # Correct syntax
self.assertEqual(m.get_dict(), {
'aaa': True,
'bbb': True,
'ccc': True,
'ddd': False
})
def test_oob_values(self):
with self.assertRaises(ValueError):
IOMasks(aaa='asd')
with self.assertRaises(ValueError):
IOMasks(1, 2, 3)
def make_request(cls, did, control_param=None, values=None, masks=None, ioconfig=None):
"""
Generate a request for InputOutputControlByIdentifier
:param did: Data identifier to read
:type did: int
:param control_param: Optional parameter that can be a value from InputOutputControlByIdentifier.ControlParam
:type control_param: int
:param values: Optional values to send to the server. This parameter will be given to :ref:`DidCodec<HelperClass_DidCodec>`.encode() method.
It can be:
- A list for positional arguments
- A dict for named arguments
- An instance of :ref:`IOValues<HelperClass_IOValues>` for mixed arguments
:type values: list, dict, :ref:`IOValues<HelperClass_IOValues>`
:param masks: Optional mask record for composite values. The mask definition must be included in ioconfig
It can be:
- A list naming the bit mask to set
- A dict with the mask name as a key and a boolean setting or clearing the mask as the value
- An instance of :ref:`IOMask<HelperClass_IOMask>`
- A boolean value to set all mask to the same value.
:type masks: list, dict, :ref:`IOMask<HelperClass_IOMask>`, bool
:param ioconfig: Definition of DID codecs. Dictionary mapping a DID (int) to a valid :ref:`DidCodec<HelperClass_DidCodec>` class or pack/unpack string.
It is possible to use composite :ref:`DidCodec<HelperClass_DidCodec>` by specifying a dict with entries : codec, mask, mask_size.
:type ioconfig: dict[int] = :ref:`DidCodec<HelperClass_DidCodec>`, dict
:raises ValueError: If parameters are out of range or missing
:raises ConfigError: If given did is not defined within ioconfig
"""
from udsoncan import Request, IOMasks, IOValues, DidCodec
ServiceHelper.validate_int(did, min=0, max=0xffff, name='DID')
if control_param is not None:
if not isinstance(control_param, int):
raise ValueError("control_param must be a valid integer")
if control_param < 0 or control_param > 3:
raise ValueError('control_param must either be returnControlToECU(0), resetToDefault(1), freezeCurrentState(2), shortTermAdjustment(3). %d given.' % control_param)
if values is not None:
if isinstance(values, list):
values = IOValues(*values)
if isinstance(values, dict):
values = IOValues(**values)
if not isinstance(values, IOValues):
raise ValueError("values must be an instance of IOValues")
if masks is not None:
if isinstance(masks, list):
masks = IOMasks(*masks)
if isinstance(masks, dict):
masks = IOMasks(**masks)
if not isinstance(masks, IOMasks) and not isinstance(masks, bool):
raise ValueError("masks must be an instance of IOMask or a boolean value")
if values is None and masks is not None:
raise ValueError('An IOValue must be given if a IOMask is provided.')
request = Request(service=cls)
request.data = b''
ioconfig = ServiceHelper.check_io_config(did, ioconfig) # IO dids are defined in client config.
request.data += struct.pack('>H', did)
# This parameters is optional according to standard
if control_param is not None:
request.data += struct.pack('B', control_param)
codec = DidCodec.from_config(ioconfig[did]) # Get IO codec from config
if values is not None:
request.data += codec.encode(*values.args, **values.kwargs)
if masks is not None: # Skip the masks byte if none is given.
if isinstance(masks, bool):
byte = b'\xFF' if masks == True else b'\x00'
if 'mask_size' in ioconfig[did]:
request.data += (byte * ioconfig[did]['mask_size'])
else:
raise ConfigError('mask_size', msg='Given mask is boolean value, indicating that all mask should be set to same value, but no mask_size is defined in configuration. Cannot guess how many bits to set.')
elif isinstance(masks, IOMasks):
if 'mask' not in ioconfig[did]:
raise ConfigError('mask', msg='Cannot apply given mask. Input/Output configuration does not define their position (and size).')
masks_config = ioconfig[did]['mask']
given_masks = masks.get_dict()
numeric_val = 0
for mask_name in given_masks:
if mask_name not in masks_config:
raise ConfigError('mask_size', msg='Cannot set mask bit for mask %s. The configuration does not define its position' % (mask_name))
if given_masks[mask_name] == True:
numeric_val |= masks_config[mask_name]
minsize = math.ceil(math.log(numeric_val+1, 2)/8.0)
size = minsize if 'mask_size' not in ioconfig[did] else ioconfig[did]['mask_size']
request.data += numeric_val.to_bytes(size, 'big')
return request