DynAIkonTrap.ursense.structure

Module Attributes

ursense_map	Table defining all possible fields in the sensor board output.
reading_type_map	Table defining reading types and by what methodology the field in question is parsed.

ursense_map

Table defining all possible fields in the sensor board output.

The format is:

{
    'field_name': {
        'reading_type': 'XY',
        'units': '',
        'var_name': 'NAME_FOR_READING',
        'description': '',
    }
}

The 'field_name' is the name of the field as output by the sensor board. The 'reading_type' dictates how to parse the reading according to reading_type_map.

reading_type_map: Dict[str, Dict[str, Union[str, Callable[[...], UrSenseParseResult]]]]

Table defining reading types and by what methodology the field in question is parsed.

The format is:

{
    'XY': {
        'description': '',
        'parser': parsing_function_for_XY,
    }
}

Where 'XY' is the type of reading, e.g., 'SI'. The 'parser' is the function that does the actual parsing.

Classes

UrSenseParseResult(reading, remaining_fields)

Parsing according to one of the methods from the reading_type_map will return this object with the frontmost field as a DynAIkonTrap.sensor.Reading and the rest as a list of strings.

class UrSenseParseResult(reading: Reading, remaining_fields: List[str])

Parsing according to one of the methods from the reading_type_map will return this object with the frontmost field as a DynAIkonTrap.sensor.Reading and the rest as a list of strings.

reading: Reading

Reading for currently parsed field

remaining_fields: List[str]

List of fields left to be parsed after the current field