MLopezJ / asset-tracker-lwm2m-js

Converts a JSON document containing the asset_tracker_v2 device and sensor data encoded as LwM2M to the JSON document required by nRF Asset Tracker.

https://github.com/MLopezJ/sset-tracker-lwm2m-js#readme

BSD 3-Clause "New" or "Revised" License

0 stars 1 forks source link

docs: feedback #6

Closed pudkrong closed 1 year ago

pudkrong commented 1 year ago

docs: link ADR 008 with a test

I am not sure whether we can detect the version from the somewhere. If so, I think the library should detect that and throw error / warning to user that we don't support.

docs: link documentation with JSDocs

I prefer @see https://github.com/MLopezJ/asset-tracker-cloud-coiote-azure-converter-js/blob/saga/documents/battery.md because it is easier to understand and follow.

MLopezJ commented 1 year ago

Github links were used in JSDocs comments. See https://github.com/MLopezJ/asset-tracker-lwm2m-js/blob/saga/src/utils/getBat.ts#L12 for example.

shortcuts were implemented. See https://github.com/MLopezJ/asset-tracker-lwm2m-js/blob/saga/src/utils/getBat.ts#L31 for example.

Regarding ADR 008, changes are happening here https://github.com/MLopezJ/asset-tracker-lwm2m-js/pull/7