Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recognition and handling of Outdoor series tag models #45

Merged
merged 4 commits into from
Dec 29, 2017
Merged

Conversation

hlapp
Copy link
Owner

@hlapp hlapp commented Dec 29, 2017

Includes new and updated API methods for querying a tag's capabilities.

Also introduces a "secondary" temperature sensor (tag.hasSecondaryTempSensor(), tag.secondarytempSensor) for those tags that can use and make available the readings from more than one temperature sensor. Currently only the "Thermocouple" model in the Outdoor series does this: the one treated primary is the external probe, and the secondary is the on-board chip. Note that although in theory the "GE Protimeter" model in the Outdoor series also measures temperature both from an (optional) external DS18B20 probe and with an on-board chip, only one reading is available (the probe if activated, and the internal on-board chip otherwise).

Temperature, moisture, and humidity sensors now have a (readonly) probeType property. For temperature sensors, it will give DS18B20 or Thermocouple or Internal; for moisture sensors BLDXXXX or 'Internal; and Internalif an external probe is unsupported by the tag for the respective sensor. Also, heprobeDisconnected` property will be present and have a boolean value for sensors for which an external probe is supported and for which its connection status can be detected. (The latter is currently true only for the "Basic" model in the Outdoor series.)

Finally, this also deprecates tag.isHTU() from the API. The name of this method was originally borrowed from the Wireless Sensor Tags Web SDK code, where the meaning was never made explicit. It was used both for querying precision of temperature reading and having a humidity sensor. Until the arrival of the Outdoor tag models, these used to be synonymous (tags with 8bit precision temperature did not have a humidity sensor). Now, however, the Outdoor tag models all support high-precision temperature reading (even if less than 13bit), yet only one of them can also measure humidity/moisture. We have been using (and documenting) tag.isHTU() in the semantics of having high-precision temperature, whereas in the vendor's Web SDK it is now resigned to querying for presence of a humidity sensor. To fully disambiguate, we are now deprecating tag.isHTU(); it is for now an alias for the preferable tag.canHighPrecTemp(), and will be removed from the API in a later version.

See #44 for further context and considerations that formed the basis for this implementation. The original issue report is #36.

This includes new and updated API methods for querying a tag's capabilities.
Also introduces a "secondary" temperature sensor for those tags can use _and_
make available the readings from more than one temperature sensor.

Currently _only_ the "Thermocouple" model in the Outdoor series does this:
the one treated primary is the external probe, and the secondary is an the
on-board chip. Note that although in theory the "GE Protimeter" model in the
Outdoor series _also_ measures temperature both from an (optional) external
DS18B20 probe and with an on-board chip, only one reading is available (the
probe if activated, and the internal on-board chip otherwise).
The name of this method was originally borrowed from the Wireless Sensor Tags
Web SDK code, where the meaning was never made explicit. It was used both for
querying precision of temperature reading _and_ having a humidity sensor.
Until the arrival of the Outdoor tag models, these used to be synonymous (tags
with 8bit precision temperature did not have a humidity sensor). Now, however,
the Outdoor tag models all support high-precision temperature reading (even if
less than 13bit), yet only one of them can also measure humidity/moisture.

Here in the API we have been using (and documenting) isHTU() in the semantics
of having high-precision temperature. To fully disambiguate, we are now
deprecating isHTU() as an alias for the preferable tag.canHighPrecTemp().
@hlapp
Copy link
Owner Author

hlapp commented Dec 29, 2017

It's worth adding that reading values from actual Outdoor series tags is untested as of now, because I don't currently own any of them. However, thanks to a few people who used my affiliate link (see How to Support), I have now been able to order two of the models, and once they are delivered, can hopefully test more thoroughly.

@hlapp hlapp merged commit 9b05824 into master Dec 29, 2017
@hlapp hlapp deleted the outdoor-probes branch December 29, 2017 20:41
@hlapp hlapp mentioned this pull request Dec 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant