Skip to content
This repository was archived by the owner on Oct 27, 2024. It is now read-only.

Commit 5485ee2

Browse files
manuarguemanuargue
committed
first working version
Signed-off-by: Manuel Argüelles <[email protected]>
0 parents  commit 5485ee2

12 files changed

+864
-0
lines changed

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/build/
2+
/dist/
3+
/thingsboard_micropython.egg-info/
4+
/venv/
5+
/__pycache__/
6+
*code-workspace
7+
MANIFEST

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# ThingsBoard MQTT MicroPython client
2+
3+
This project is a MicroPython library that provides an client for the [Device](https://thingsboard.io/docs/reference/mqtt-api/) API of [ThingsBoard](https://thingsboard.io/) open-source IoT Platform.
4+
5+
The library consists of a thin wrapper around the MicroPython MQTT module, [mqtt.robust](https://github.com/micropython/micropython-lib/blob/master/micropython/umqtt.robust/umqtt/robust.py).
6+
7+
## Installation
8+
9+
To install using pip:
10+
11+
```python
12+
import upip
13+
upip.install('thingsboard-micropython')
14+
```
15+
16+
## Getting Started
17+
18+
Client initialization and telemetry publishing:
19+
20+
```python
21+
from uthingsboard.client import TBDeviceMqttClient
22+
23+
client = TBDeviceMqttClient('test01', '127.0.0.1', user='test01', password='test01')
24+
25+
# Connect to ThingsBoard
26+
client.connect()
27+
28+
# Sending telemetry
29+
telemetry = {'temperature': 41.9, 'enabled': False}
30+
client.send_telemetry(telemetry)
31+
32+
# Checking for incoming subscriptions or RPC call requests (non-blocking)
33+
client.check_msg()
34+
35+
# Disconnect from ThingsBoard
36+
client.disconnect()
37+
```
38+
39+
## Examples
40+
41+
More examples can be found in [examples](https://github.com/coredumplabs/thingsboard-micropython/tree/main/examples) directory.
42+
43+
## Support
44+
45+
- QoS 0 and 1 as supported by the backend MQTT library, [mqtt.robust](https://github.com/micropython/micropython-lib/blob/master/micropython/umqtt.robust/umqtt/robust.py).
46+
- All [Device](https://thingsboard.io/docs/reference/mqtt-api/), except Provisioning.
47+
- Tested only on ESP32 board running MicroPython v1.16 generic.
48+
49+
## Acknowledgment
50+
51+
This library is an adapted version of the official [ThingsBoard client SDK for Python](https://github.com/thingsboard/thingsboard-python-client-sdk),
52+
to run in MicroPython.
53+
54+
## License
55+
56+
This project is released under [Apache 2.0 License](https://github.com/coredumplabs/thingsboard-micropython/tree/main/LICENSE).

‎examples/attr_req.py

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Copyright 2021 Coredump Labs
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
from uthingsboard.client import TBDeviceMqttClient
6+
7+
8+
def on_attributes_change(data):
9+
print(data)
10+
11+
12+
def main():
13+
client = TBDeviceMqttClient('test01', '127.0.0.1')
14+
client.connect()
15+
16+
# request attributes, wait for reply and process it in the callback
17+
client.request_attributes(client_keys=['myAttr1'],
18+
shared_keys=['myAttr2', 'myAttr3'],
19+
callback=on_attributes_change)
20+
client.wait_msg()
21+
22+
client.disconnect()
23+
24+
25+
if __name__ == '__main__':
26+
main()

‎examples/attr_subs.py

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Copyright 2021 Coredump Labs
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
from uthingsboard.client import TBDeviceMqttClient
6+
7+
8+
def callback(data):
9+
print(data)
10+
11+
12+
def main():
13+
client = TBDeviceMqttClient('test01', '127.0.0.1')
14+
client.connect()
15+
16+
sub_id_1 = client.subscribe_to_attribute('uploadFrequency', callback)
17+
sub_id_2 = client.subscribe_to_all_attributes(callback)
18+
19+
client.unsubscribe_from_attribute(sub_id_1)
20+
client.unsubscribe_from_attribute(sub_id_2)
21+
22+
client.disconnect()
23+
24+
25+
if __name__ == '__main__':
26+
main()

‎examples/freemem.py

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Copyright 2021 Coredump Labs
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
import gc
6+
import time
7+
8+
from uthingsboard.client import TBDeviceMqttClient
9+
10+
11+
telemetry_interval = 5
12+
client = TBDeviceMqttClient('test01', '127.0.0.1')
13+
14+
15+
# this callback changes global variable defining how often telemetry is sent
16+
def on_telemetry_interval_change(value):
17+
global telemetry_interval
18+
if 'telemetryInterval' in value:
19+
telemetry_interval = int(value['telemetryInterval'])
20+
elif 'shared' in value and 'telemetryInterval' in value['shared']:
21+
telemetry_interval = int(value['shared']['telemetryInterval'])
22+
23+
24+
# this callback handles RPC requests from server
25+
def handle_rpc_request(request_id, method, params):
26+
print('Request ID {req}: {method}({params})'.format(req=request_id,
27+
method=method,
28+
params=params))
29+
if method == 'getFreeMemory':
30+
client.send_rpc_reply(request_id, {'memFree': gc.mem_free()})
31+
32+
33+
def main():
34+
client.set_server_side_rpc_request_handler(handle_rpc_request)
35+
client.connect()
36+
37+
# subscribe to future changes of upload frequency
38+
client.subscribe_to_attribute('telemetryInterval',
39+
on_telemetry_interval_change)
40+
41+
# fetch the latest setting for upload frequency configured on the server
42+
client.request_attributes(shared_keys=['telemetryInterval'],
43+
callback=on_telemetry_interval_change)
44+
45+
while True:
46+
client.send_telemetry({'getFreeMemory': gc.mem_free()})
47+
client.check_msg()
48+
time.sleep(telemetry_interval)
49+
50+
51+
if __name__ == '__main__':
52+
main()

‎examples/rpc_request.py

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Copyright 2021 Coredump Labs
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
from uthingsboard.client import TBDeviceMqttClient
6+
7+
8+
def callback(resp_id, data):
9+
print('Response {id}: {data})'.format(id=resp_id, data=data))
10+
11+
12+
def main():
13+
client = TBDeviceMqttClient('test01', '127.0.0.1')
14+
client.connect()
15+
16+
# call "getTime" on server and receive result, then process it on callback
17+
client.send_rpc_call('getTime', {}, callback)
18+
client.wait_msg()
19+
20+
client.disconnect()
21+
22+
23+
if __name__ == '__main__':
24+
main()

0 commit comments

Comments
 (0)