uds.utilities.common_types

Module with all common types (and its aliases) used in the package and helper functions for these types.

Module Contents

Functions

validate_nibble(value)	Validate whether provided value stores a nibble value.
validate_raw_byte(value)	Validate whether provided value stores a raw byte value.
validate_raw_bytes(value, allow_empty = False)	Validate whether provided value stores raw bytes value.

Attributes

Nibble	Alias of a nibble value (integer in range 0x0-0xF).
RawByte	Alias of a byte value (integer in range 0x00-0xFF).
RawBytesTuple	Alias of a tuple filled with byte values.
RawBytesSet	Alias of a set filled with byte values.
RawBytesList	Alias of a list filled with byte values.
RawBytes	Alias of a sequence filled with byte values.
TimeMilliseconds	Alias of a time value in milliseconds.
TimeStamp	Alias of a timestamp value.

uds.utilities.common_types.Nibble

Alias of a nibble value (integer in range 0x0-0xF).

uds.utilities.common_types.RawByte

Alias of a byte value (integer in range 0x00-0xFF).

uds.utilities.common_types.RawBytesTuple

Alias of a tuple filled with byte values.

uds.utilities.common_types.RawBytesSet

Alias of a set filled with byte values.

uds.utilities.common_types.RawBytesList

Alias of a list filled with byte values.

uds.utilities.common_types.RawBytes

Alias of a sequence filled with byte values.

uds.utilities.common_types.TimeMilliseconds

Alias of a time value in milliseconds.

uds.utilities.common_types.TimeStamp

Alias of a timestamp value.

uds.utilities.common_types.validate_nibble(value)

Validate whether provided value stores a nibble value.

Parameters

value (Any) – Value to validate.

Raises

• TypeError – Value is not int type.

• ValueError – Value is out of byte range (0x0-0xF).

Return type

None

uds.utilities.common_types.validate_raw_byte(value)

Validate whether provided value stores a raw byte value.

Parameters

value (Any) – Value to validate.

Raises

• TypeError – Value is not int type.

• ValueError – Value is out of byte range (0x00-0xFF).

Return type

None

uds.utilities.common_types.validate_raw_bytes(value, allow_empty=False)

Validate whether provided value stores raw bytes value.

Parameters

• value (Any) – Value to validate.

• allow_empty (bool) – True if empty list is allowed, False otherwise.

Raises

• TypeError – Value is not tuple or list type.

• ValueError – Value does not contain raw bytes (int value between 0x00-0xFF) only.

Return type

None