-
Notifications
You must be signed in to change notification settings - Fork 80
Added provisioning and firmware update examples #95
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,50 @@ | ||
# Copyright 2025 ThingsBoard | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# Example script to device provisioning using the DeviceClient | ||
|
||
import asyncio | ||
from random import randint | ||
|
||
from tb_mqtt_client.entities.data.provisioning_request import AccessTokenProvisioningCredentials, ProvisioningRequest | ||
from tb_mqtt_client.entities.data.timeseries_entry import TimeseriesEntry | ||
from tb_mqtt_client.service.device.client import DeviceClient | ||
|
||
|
||
async def main(): | ||
provisioning_credentials = AccessTokenProvisioningCredentials( | ||
provision_device_key='YOUR_PROVISION_DEVICE_KEY', | ||
provision_device_secret='YOUR_PROVISION_DEVICE_SECRET', | ||
) | ||
provisioning_request = ProvisioningRequest('localhost', credentials=provisioning_credentials) | ||
provisioning_response = await DeviceClient.provision(provisioning_request) | ||
|
||
if provisioning_response.error is not None: | ||
print(f"Provisioning failed: {provisioning_response.error}") | ||
return | ||
|
||
print('Provisined device config: ', provisioning_response) | ||
|
||
# Create a DeviceClient instance with the provisioned device config | ||
client = DeviceClient(provisioning_response.result) | ||
await client.connect() | ||
|
||
# Send single telemetry entry to provisioned device | ||
await client.send_telemetry(TimeseriesEntry("batteryLevel", randint(0, 100))) | ||
|
||
await client.stop() | ||
|
||
|
||
if __name__ == "__main__": | ||
asyncio.run(main()) |
This file contains hidden or 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,51 @@ | ||
# Copyright 2025 ThingsBoard | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# Example script to update firmware using the DeviceClient | ||
|
||
import asyncio | ||
from time import monotonic | ||
|
||
from tb_mqtt_client.common.config_loader import DeviceConfig | ||
from tb_mqtt_client.service.device.client import DeviceClient | ||
|
||
|
||
firmware_received = asyncio.Event() | ||
firmware_update_timeout = 30 | ||
|
||
|
||
async def firmware_update_callback(_, payload): | ||
print(f"Firmware update payload received: {payload}") | ||
firmware_received.set() | ||
|
||
|
||
async def main(): | ||
config = DeviceConfig() | ||
config.host = "localhost" | ||
config.access_token = "YOUR_ACCESS_TOKEN" | ||
|
||
client = DeviceClient(config) | ||
await client.connect() | ||
|
||
await client.update_firmware(on_received_callback=firmware_update_callback) | ||
|
||
update_started = monotonic() | ||
while not firmware_received.is_set() and monotonic() - update_started < firmware_update_timeout: | ||
await asyncio.sleep(1) | ||
|
||
await client.stop() | ||
|
||
|
||
if __name__ == "__main__": | ||
asyncio.run(main()) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.