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.

Sign up for GitHub

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

Jump to bottom

Registry.getTwin signature returns any instead of Twin #673

Closed
chrisahardie opened this issue Jan 12, 2020 · 4 comments · Fixed by #737
Closed

Registry.getTwin signature returns any instead of Twin #673

chrisahardie opened this issue Jan 12, 2020 · 4 comments · Fixed by #737
Assignees
@anthonyvercolano
Labels
customer-reported enhancement IoTSDK tracks all IoT SDK issues across the board

Comments

@chrisahardie
Copy link

chrisahardie commented Jan 12, 2020 •
edited
Loading

getTwin has the following signature:

getTwin(deviceId: string, done: HttpResponseCallback<any>): void;

Any reason this couldn't be:

getTwin(deviceId: string, done: HttpResponseCallback<Twin>): void;

If there's no issue and you'd like, I'd be happy to submit a PR.
@anthonyvercolano
Copy link
Contributor

I agree it seems better to make this change.

Sadly, since this is a published API, and if this change were made it conceivably could be a breaking change by making the API more restrictive.

I'll ask some others, but, I'm hesitant.

@anthonyvercolano
Copy link
Contributor

I've talked with some folk. We will be changing the type to Twin. If you could wait, a few weeks, we'll put it (and a couple of others) in the next release.

@chrisahardie
Copy link
Author

Cool, it's just a convenience for me, definitely not critical.

@jebrando jebrando added enhancement and removed bug labels Jan 30, 2020
@elhorton elhorton added IoTSDK tracks all IoT SDK issues across the board customer-reported labels Mar 6, 2020
anthonyvercolano added a commit to anthonyvercolano/azure-iot-sdk-node that referenced this issue Mar 30, 2020
@anthonyvercolano
fix(azure-iothub): fix signatue for getTwin, updateTwin, updateModule…
025ff8e 
…Twin to use Twin

fix Azure#673
@anthonyvercolano anthonyvercolano mentioned this issue Mar 30, 2020
Merged
@az-iot-builder-01
Copy link
Collaborator

@chrisahardie, thank you for your contribution to our open-sourced project! Please help us improve by filling out this 2-minute customer satisfaction survey

@anthonyvercolano anthonyvercolano mentioned this issue Apr 24, 2020
Merged
jebrando added a commit that referenced this issue Jul 20, 2020
@jebrando @anthonyvercolano
@elhorton @az-iot-builder-01 @jhutchings1 @olivakar @YoDaMa
chore: updating pnp-preview-refresh to master branch (#853)
63a9cf1 
* fix(azure-iothub): fix signatue for getTwin, updateTwin, updateModuleTwin to use Twin

fix #673

* improvement(provisioning samples): use the results of the registration to create and open device

* test(azure-iot-device-mqtt): reformat _mqtt_test.js (#741)

* (chore) add issue templates workflow

* Delete ISSUE_TEMPLATE.md

* Update bug-report.md

* fix(azure-iot-mqtt-base): forceReconnect for disconnecting hang in mqtt-base (#770)

* release(2020-04-24): bump package versions (#771)

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* refactor: update to mqtt.js v4 (#772)

* build: update to mqtt.js v4

* refactor: add debug logs

* fix: eslint issue

* chore: remove network_e2e directory - no longer used (#775)

* refactor: expose connection error in mqtt (#776)

* release(2020-05-07): bump package versions (#788)

* release(2020-05-07): bump package versions

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* refactor(multipe packages): c2d states no longer using booleans (#797)

This moves the logic of checking if C2D is enabled down to the transport level, since it is not necessarily accurate to represent it at the device client level. There is not enough information at that level to make totally accurate judgements of if it is connected or not.

* chore(azure-iot-device-amqp): debug logs for c2d (#804)

* build: update to mqtt.js v4

* chore: add debug logs

* chore(azure-iot-device): updating api version to support twin arrays (#806)

* improvement(azure-iot-mqtt-base): maintain knowledge of on the wire publishes (#808)

By tracking the on the wire publishes we can reliably complete in case of disconnects or other
errors.

* feat(azure-iot-mqtt-device): modelID option (#809)

This adds the setOption for ModelID, which will enable users to use the existing device client library as a PnP library. To accomodate the lack of support in the existing service API, a switching API call has been added that will use the preview API version if the modelID is set.

* release(2020-05-28): bump package versions (#810)

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* Create synctodevops.yml

* chore(azure-iot-provisioning-device): update samples to use env var (#816)

* Add CodeQL security scanning (#815)

Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>

* improvement(azure-iot-mqtt-base): add timeouts to publishes that have… (#818)

* improvement(azure-iot-mqtt-base): add timeouts to publishes that have not been PUBACKed by the service

744

* update classes and unique identifiers.

* chore: create config.yml for issue templates (#823)

* chore: create config.yml for issue templates

* chore: update technical question for msft q&a

* fix: add vanity link for IoT help

* chore: update technical question options

* fix: add https://

* fix: add https://

* fix: add https://

* fix: add https://

Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>

* feat(azure-iot-device): adds emit to connect (#819)

'connect' is emitted whenever the device transport FSM enters the "connected" state for MQTT, and "authenticated" for AMQP.

* fix(azure-iot-device): lint error on simple sample (#826)

* fix(azure-iot-device): lint error on simple sample

* fix(azure-iot-device): add sample linting to the CI

* refactor(multiple): update to typescript 3.7.5 move to dist instead of lib parameter checking and suppression (#824)

* chore: updating docs to clarify edge support for linux only

* refactor(multiple): update to typescript 3.7.5 move to dist etc (#830)

* chore: node pnp sample for summer

* chore: update prov sample to use env variables (#831)

* chore: node pnp sample for summer

* refactor(multiple): update to typescript 3.7.5 move to dist vs lib other minor (#833)

* chore: node pnp sample for summer

* chore: rename digital-twin-model-id to model-id in mqtt (#829)

* chore: node pnp sample for summer

* chore: node pnp sample for summer

* chore: initial addition of pnp simple thermostat sample (#827)

* chore: node pnp sample for summer

* release(2020-07-06): bump package versions (#838)

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* chore: fixing the sample for feedback (#839)

* chore: remove writable property in reported (#842)

* chore: some changes

* chore: some changes

* chore: some changes

* Update pnpTemperatureController.js

* Updated file upload sample to reflect current SDK changes. (#834)

* fix(sample): update sample to use current SDK changes

* fix(sample): update to use latest SDK changes, add use strict

* fix(sample): update sample to use current SDK changes, fix linting issue

* Update upload_to_blob_advanced.js

* Update upload_to_blob_advanced.js

Co-authored-by: Chandler Lattin <chlattin@microsoft.com>
Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@microsoft.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@gmail.com>

* chore: align environment variable names

* Update pnpTemperatureController.js

* chore: removing all the lib folders in repo

Co-authored-by: Anthony Ercolano <toercola@microsoft.com>
Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@microsoft.com>
Co-authored-by: Elena Horton <52430760+elhorton@users.noreply.github.com>
Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>
Co-authored-by: Justin Hutchings <jhutchings1@users.noreply.github.com>
Co-authored-by: olivakar <oliva.kar@microsoft.com>
Co-authored-by: olivakar <oliva.tanusree@gmail.com>
Co-authored-by: Chandler Lattin <chandlerlattin@knights.ucf.edu>
Co-authored-by: Chandler Lattin <chlattin@microsoft.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@gmail.com>
anthonyvercolano added a commit that referenced this issue Jul 27, 2020
@anthonyvercolano @elhorton
@az-iot-builder-01 @jebrando @jhutchings1 @olivakar @YoDaMa @tonygleck
Update the hub package to 1.12.4-pnp-refresh.4 (#867)
ba829ae 
* fix(azure-iothub): fix signatue for getTwin, updateTwin, updateModuleTwin to use Twin

fix #673

* improvement(provisioning samples): use the results of the registration to create and open device

* test(azure-iot-device-mqtt): reformat _mqtt_test.js (#741)

* (chore) add issue templates workflow

* Delete ISSUE_TEMPLATE.md

* Update bug-report.md

* fix(azure-iot-mqtt-base): forceReconnect for disconnecting hang in mqtt-base (#770)

* release(2020-04-24): bump package versions (#771)

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* refactor: update to mqtt.js v4 (#772)

* build: update to mqtt.js v4

* refactor: add debug logs

* fix: eslint issue

* chore: remove network_e2e directory - no longer used (#775)

* refactor: expose connection error in mqtt (#776)

* release(2020-05-07): bump package versions (#788)

* release(2020-05-07): bump package versions

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* refactor(multipe packages): c2d states no longer using booleans (#797)

This moves the logic of checking if C2D is enabled down to the transport level, since it is not necessarily accurate to represent it at the device client level. There is not enough information at that level to make totally accurate judgements of if it is connected or not.

* chore(azure-iot-device-amqp): debug logs for c2d (#804)

* build: update to mqtt.js v4

* chore: add debug logs

* chore(azure-iot-device): updating api version to support twin arrays (#806)

* improvement(azure-iot-mqtt-base): maintain knowledge of on the wire publishes (#808)

By tracking the on the wire publishes we can reliably complete in case of disconnects or other
errors.

* feat(azure-iot-mqtt-device): modelID option (#809)

This adds the setOption for ModelID, which will enable users to use the existing device client library as a PnP library. To accomodate the lack of support in the existing service API, a switching API call has been added that will use the preview API version if the modelID is set.

* release(2020-05-28): bump package versions (#810)

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* Create synctodevops.yml

* chore(azure-iot-provisioning-device): update samples to use env var (#816)

* Add CodeQL security scanning (#815)

Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>

* improvement(azure-iot-mqtt-base): add timeouts to publishes that have… (#818)

* improvement(azure-iot-mqtt-base): add timeouts to publishes that have not been PUBACKed by the service

744

* update classes and unique identifiers.

* chore: create config.yml for issue templates (#823)

* chore: create config.yml for issue templates

* chore: update technical question for msft q&a

* fix: add vanity link for IoT help

* chore: update technical question options

* fix: add https://

* fix: add https://

* fix: add https://

* fix: add https://

Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>

* feat(azure-iot-device): adds emit to connect (#819)

'connect' is emitted whenever the device transport FSM enters the "connected" state for MQTT, and "authenticated" for AMQP.

* fix(azure-iot-device): lint error on simple sample (#826)

* fix(azure-iot-device): lint error on simple sample

* fix(azure-iot-device): add sample linting to the CI

* refactor(multiple): update to typescript 3.7.5 move to dist instead of lib parameter checking and suppression (#824)

* chore: updating docs to clarify edge support for linux only

* refactor(multiple): update to typescript 3.7.5 move to dist etc (#830)

* chore: node pnp sample for summer

* chore: update prov sample to use env variables (#831)

* chore: node pnp sample for summer

* refactor(multiple): update to typescript 3.7.5 move to dist vs lib other minor (#833)

* chore: node pnp sample for summer

* chore: rename digital-twin-model-id to model-id in mqtt (#829)

* chore: node pnp sample for summer

* chore: node pnp sample for summer

* chore: initial addition of pnp simple thermostat sample (#827)

* chore: node pnp sample for summer

* release(2020-07-06): bump package versions (#838)

Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>

* chore: fixing the sample for feedback (#839)

* chore: remove writable property in reported (#842)

* chore: some changes

* chore: some changes

* chore: some changes

* Update pnpTemperatureController.js

* Updated file upload sample to reflect current SDK changes. (#834)

* fix(sample): update sample to use current SDK changes

* fix(sample): update to use latest SDK changes, add use strict

* fix(sample): update sample to use current SDK changes, fix linting issue

* Update upload_to_blob_advanced.js

* Update upload_to_blob_advanced.js

Co-authored-by: Chandler Lattin <chlattin@microsoft.com>
Co-authored-by: Anthony V. Ercolano <anthonyvercolano@users.noreply.github.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@microsoft.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@gmail.com>

* chore: align environment variable names

* Update pnpTemperatureController.js

* chore: removing all the lib folders in repo

* chore: removing a few more lib folders

* chore: updating twin calls to the pnp api-version

* chore: adding modelId object to twin

* chore: fixing registry sample

* fix(azure-iothub): update vesion and support modelId service side

Updated to -pnp-refresh.4. Fixed the sample to print out the modelId.  Updated various dependents to
the latest branch.

Co-authored-by: Yoseph Maguire <yoseph.maguire@microsoft.com>
Co-authored-by: Elena Horton <52430760+elhorton@users.noreply.github.com>
Co-authored-by: Azure IoT Client Build <aziotclb@microsoft.com>
Co-authored-by: Jelani Brandon <jelani.brandon@microsoft.com>
Co-authored-by: Justin Hutchings <jhutchings1@users.noreply.github.com>
Co-authored-by: olivakar <oliva.kar@microsoft.com>
Co-authored-by: olivakar <oliva.tanusree@gmail.com>
Co-authored-by: Chandler Lattin <chandlerlattin@knights.ucf.edu>
Co-authored-by: Chandler Lattin <chlattin@microsoft.com>
Co-authored-by: Yoseph Maguire <yoseph.maguire@gmail.com>
Co-authored-by: Jelani Brandon <jelanibrandon@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@anthonyvercolano anthonyvercolano

Labels
customer-reported enhancement IoTSDK tracks all IoT SDK issues across the board
Projects
None yet
Milestone
No milestone
5 participants
@chrisahardie @jebrando @anthonyvercolano @az-iot-builder-01 @elhorton