adafruit-mirror/Adafruit_IO_Python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fixup Client and MQTTClient calls

Browse source 
there si a missing parameter 'user' in the documentation.
This commit is contained in:
Eric Keller 2018-07-16 19:52:27 +02:00 committed by GitHub
parent 82a51552fb
commit 29dcc0c718
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/quickstart.rst
View file

@ -6,7 +6,7 @@ Here's a short example of how to send a new value to a feed (creating the feed i
# Import library and create instance of REST client. # Import library and create instance of REST client.
from Adafruit_IO import Client from Adafruit_IO import Client
aio = Client('YOUR ADAFRUIT IO KEY') aio = Client('YOUR ADAFRUIT USER', 'YOUR ADAFRUIT IO KEY')
# Send the value 100 to a feed called 'Foo'. # Send the value 100 to a feed called 'Foo'.
aio.send('Foo', 100) aio.send('Foo', 100)
@ -41,17 +41,20 @@ Then a REST API client can be created with code like:
.. code-block:: python .. code-block:: python
aio = Client('xxxxxxxxxxxx') aio = Client('user', 'xxxxxxxxxxxx')
Where ``'xxxxxxxxxxxx'`` is your Adafruit IO API key. Where ``'xxxxxxxxxxxx'`` is your Adafruit IO API key.
Where ``'user'`` is your Adafruit username.
Alternatively an MQTT client can be created with code like: Alternatively an MQTT client can be created with code like:
.. code-block:: python .. code-block:: python
mqtt = MQTTClient('xxxxxxxxxxxx') mqtt = MQTTClient('user', 'xxxxxxxxxxxx')
Again where ``'xxxxxxxxxxxx'`` is your Adafruit IO API key. Again where ``'xxxxxxxxxxxx'`` is your Adafruit IO API key.
Again where ``'user'`` is your Adafruit username.
Your program can use either or both the REST API client and MQTT client, depending on your needs. Your program can use either or both the REST API client and MQTT client, depending on your needs.