Skip to content

Commit

Permalink
Release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Kacp3r3 committed Nov 25, 2020
1 parent a665d8c commit 302a54d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,20 @@ def foo():

As soon the data is send, your payload is cleared and waiting for the next sending.

### Advanced payload feautres ###
```Python
#add "model" property to your message
lo.addModel("exampleName")

#Add "tag" property to your message
lo.addTag("kitchen")
lo.addTags(["humidity","bathroom"])

#Use your object as payload (this function doesn't append current paylod)
obj = ["example":"value", "example2":"value2" ]
lo.setObjectAsPayload(obj)
```


### Connect, disconnect and loop ###
You can control the connection and disconnection of your device using `connect()` and `disconnect()`.
Expand All @@ -157,7 +171,7 @@ def foo():


# Installation guide for uPython #

## Example for ESP8266 ##
## Requirements ##
1. [ampy](https://learn.adafruit.com/micropython-basics-load-files-and-run-code/install-ampy)
2. [umqttsimple, umqttrobust and ssl](https://github.com/micropython/micropython-lib)
Expand All @@ -175,7 +189,7 @@ def foo():
```
ampy -pCOMXX put main.py
```
3. Setup internet connection in boot.py file and upload it into device. Example for esp8266
3. Setup internet connection in boot.py file and upload it into device.
```Python
# This file is executed on every boot (including wake-boot from deepsleep)
#import esp
Expand Down
4 changes: 4 additions & 0 deletions THIRD_PARTY.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
COMPONENT | VERSION | LICENCE | URL
-------------------------------------------------------------------------------------------------------------------------------------------------
Paho-mqtt | Latest | BSD + EPL/EDL | https://github.com/eclipse/paho.mqtt.python/blob/master/LICENSE.txt
simple, robust, ssl micropython modules | Latest | MIT License | https://github.com/micropython/micropython-lib/blob/master/LICENSE

0 comments on commit 302a54d

Please sign in to comment.