neat.translator package

Module contents

neat.translator.get_translator(requester_name: str) → neat.translator._common.AbstractTranslator[source]

Tries to retrieve a supported translator given a requesters name.

Parameters:requester_name (str) – The requester’s class name
Returns:A supported translator
Return type:AbstractTranslator

Submodules

neat.translator.obvius module

class neat.translator.obvius.ObviusTranslator[source]

Bases: neat.translator._common.AbstractTranslator

The translator for Obvius devices.

parser

The xml parser to use for parsing the returned requester content.

supported_requesters = ('ObviusRequester',)
translate(data: str, meta: dict = {}) → None[source]

Translates Obvius data to a record.

Parameters:
  • data (str) – The xml returned from the Obvius endpoint
  • meta (dict) – Any additional data given to the requester
Returns:

Does not return

Return type:

None

unit_map

The mapping of Obvius units to valid pint units.

validate(data: str) → bool[source]

Checks if the data from the Obvius is valid.

Parameters:data (str) – The data returned from a supported requester
Returns:True if the data is valid, otherwise False
Return type:bool