-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Set NotImplemented from device schema. (#31)
* Draft test example. For coverage on all of the attribute setters and the translation from info dict to the attributes. * comment about plans on senml parsing. * linter fixes. * Add tests for H35i and T10i. * lint fixes. * Update golden for H35i * Add a pytest workflow. * rename the workflow. Apparently I cannot trigger it. I think it is also missing a pip install -e . * add installation step. * Add a readme for the golden data generation. * add Intermediate representation of AWS devices. - documenting reverse engineering the fields in the device configuration json. -add senml sensor pack parsing. * add tests. * Use SensorPack in device_aws. * Add a query_json helper to the ir. * Parse the device IR in refresh. * ruff. * Add NotImplemented detection If a sensor is not implemented by the device, then DeviceAws sets it to NotImplemented. If a sensor is implemented but its value is unavailable, sets it to None. (the second case, is for example when H35i's fan is in standby, then h and t are unavaiable) * use the new type statement. * Update to py3.12's type parameter syntax. * Add a few comments. * Ensure all fields are checked. * fix typing of running. * Add comment about specialness of AttributeType. * Rename ir_aws to intermediate_representation_aws. Also add the forgotten unit test file for it. * rename usage to usage_percentage. * Redefine missing di fields as NotImplemented. * update pytest workflow. * Remove the txt version files. * Comment about the assert helper.
- Loading branch information
1 parent
e0c979b
commit e19faf4
Showing
5 changed files
with
570 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| from typing import Any, TypeVar | ||
| from collections.abc import Iterable | ||
| import dataclasses | ||
| import base64 | ||
|
|
||
| type ScalarType = str | float | bool | ||
| type MappingType = dict[str, "ObjectType"] | ||
| type SequenceType = list["ObjectType"] | ||
| type ObjectType = ScalarType | MappingType | SequenceType | ||
|
|
||
|
|
||
| def query_json(jsonobj: ObjectType, path: str): | ||
| value = jsonobj | ||
| segs = path.split(".") | ||
| for i, seg in enumerate(segs[:-1]): | ||
| if not isinstance(value, dict | list): | ||
| raise KeyError( | ||
| f"cannot resolve path segment on a scalar " | ||
| f"when resolving segment {i}:{seg} of {path}.") | ||
| if isinstance(value, list): | ||
| value = value[int(seg)] | ||
| else: | ||
| try: | ||
| value = value[seg] | ||
| except KeyError: | ||
| raise KeyError( | ||
| f"cannot resolve path segment on a scalar " | ||
| f"when resolving segment {i}:{seg} of {path}. " | ||
| f"available keys are {value.keys()}.") | ||
|
|
||
| # last segment returns None if it is not found. | ||
| return value.get(segs[-1]) | ||
|
|
||
|
|
||
| def parse_json[T](kls: type[T], jsonobj: MappingType) -> dict[str, T]: | ||
| """Parses a json mapping object to dict. | ||
| The key is preserved. The value is parsed as dataclass type kls. | ||
| """ | ||
| result = {} | ||
| fields = dataclasses.fields(kls) | ||
|
|
||
| for key, value in jsonobj.items(): | ||
| a = dict(value) # make a copy. | ||
| kwargs = {} | ||
| for field in fields: | ||
| if field.name == "extra_fields": | ||
| continue | ||
| if field.default is dataclasses.MISSING: | ||
| kwargs[field.name] = a.pop(field.name) | ||
| else: | ||
| kwargs[field.name] = a.pop(field.name, field.default) | ||
|
|
||
| result[key] = kls(**kwargs, extra_fields=a) | ||
| return result | ||
|
|
||
|
|
||
| ######################## | ||
| # Blueair AWS API Schema. | ||
|
|
||
| @dataclasses.dataclass | ||
| class Attribute: | ||
| """DeviceAttribute(da); defines an attribute | ||
| An attribute is most likely mutable. An attribute may | ||
| also have alias names, likely derived from the 'dc' relation | ||
| e.g. a/sb, a/standby all refer to the 'sb' attribute. | ||
| """ | ||
| extra_fields : MappingType | ||
| n: str # name | ||
| a: int | bool # default attribute value, example value? | ||
| e: bool # ??? always True | ||
| fe:bool # ??? always True | ||
| ot: str # object type? topic type? | ||
| p: bool # only false for reboot and sflu | ||
| tn: str # topic name a path-like name d/????/a/{n} | ||
|
|
||
|
|
||
| @dataclasses.dataclass | ||
| class Sensor: | ||
| """DeviceSensor(ds); seems to define a sensor. | ||
| We never directly access these objects. Thos this defines | ||
| the schema for 'h', 't', 'pm10' etc that gets returned in | ||
| the sensor_data senml SensorPack. | ||
| """ | ||
| extra_fields : MappingType | ||
| n: str # name | ||
| i: int # integration time? in millis | ||
| e: bool # ??? | ||
| fe: bool # ??? always True. | ||
| ot: str # object type / topic name | ||
| tf: str # senml+json; topic format | ||
| tn: str # topic name a path-like name d/????/s/{n} | ||
| ttl: int # only seen 0 or -1, not sure if used. | ||
|
|
||
| @dataclasses.dataclass | ||
| class Control: | ||
| """DeviceControl (dc); seems to define a state. | ||
| The states SensorPack seem to be using fields defined | ||
| in dc. The only exception is 'online' which is not defined | ||
| here. | ||
| """ | ||
| extra_fields : MappingType | ||
| n: str # name | ||
| v: int | bool | ||
| a: str | None = None | ||
| s: str | None = None | ||
| d: str | None = None # device info json path | ||
|
|
||
|
|
||
| ######################## | ||
| # SenML RFC8428 | ||
|
|
||
| @dataclasses.dataclass | ||
| class Record: | ||
| """A RFC8428 SenML record, resolved to Python types.""" | ||
| name: str | ||
| unit: str | None | ||
| value: ScalarType | ||
| timestamp: float | None | ||
| integral: float | None | ||
|
|
||
|
|
||
| class SensorPack(list[Record]): | ||
| """Represents a RFC8428 SensorPack, resolved to Python Types.""" | ||
|
|
||
| def __init__(self, stream: Iterable[MappingType]): | ||
| seq = [] | ||
| for record in stream: | ||
| rs = None | ||
| rt = None | ||
| rn = 0 | ||
| ru = None | ||
| for label, value in record.items(): | ||
| match label: | ||
| case 'bn' | 'bt' | 'bu' | 'bv' | 'bs' | 'bver': | ||
| raise ValueError("TODO: base fields not supported. c.f. RFC8428, 4.1") | ||
| case 't': | ||
| rt = float(value) | ||
| case 's': | ||
| rs = float(value) | ||
| case 'v': | ||
| rv = float(value) | ||
| case 'vb': | ||
| rv = bool(value) | ||
| case 'vs': | ||
| rv = str(value) | ||
| case 'vd': | ||
| rv = bytes(base64.b64decode(value)) | ||
| case 'n': | ||
| rn = str(value) | ||
| case 'u': | ||
| ru = str(value) | ||
| case 't': | ||
| rn = float(value) | ||
| seq.append(Record(name=rn, unit=ru, value=rv, integral=rs, timestamp=rt)) | ||
| super().__init__(seq) | ||
|
|
||
| def to_latest_value(self) -> dict[str, ScalarType]: | ||
| return {rn : record.value for rn, record in self.to_latest().items()} | ||
|
|
||
| def to_latest(self) -> dict[str, Record]: | ||
| latest = {} | ||
| for record in self: | ||
| rn = record.name | ||
| if record.name not in latest: | ||
| latest[rn] = record | ||
| elif record.timestamp is None: | ||
| latest[rn] = record | ||
| elif latest[record.name].timestamp is None: | ||
| latest[rn] = record | ||
| elif latest[record.name].timestamp < record.timestamp: | ||
| latest[rn] = record | ||
| return latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| This folder contains golden device info returned from blueair AWS servers. | ||
|
|
||
| The content of the text file is the first element of the deviceInfo field of | ||
| the response from the initial get info API call, dumped as a json with intent 2 in the debug logs. | ||
|
|
||
| the response from the initial get info API call, dumped as a json with intent 2 | ||
| in the debug logs. |
Oops, something went wrong.