parent
dc5adfb2bf
commit
196cc3a331
@ -0,0 +1,63 @@ |
||||
## mqttRSSI |
||||
|
||||
### Publish ESP8266/ESP32 WiFi signal strength to MQTT broker |
||||
|
||||
This example is based on the description of the MQTT client application in the [AutoConnect documentation](https://hieromon.github.io/AutoConnect/examples/index.html#used-with-mqtt-as-a-client-application). To experience this example, you need to prepare the [ThingSpeak](https://thingspeak.com/) account and the channel for MQTT message exchange in advance. |
||||
|
||||
<img src="https://hieromon.github.io/AutoConnect/images/ac_mqtt_setting.png" width="40%"/> |
||||
|
||||
<img src="https://hieromon.github.io/AutoConnect/images/ChannelStatus.png" width="40%"/> |
||||
|
||||
The ThingSpeak is the open IoT platform. It is capable of sending data privately to the cloud and analyzing, visualizing its data. If you do not have an account of ThingSpeak, you need that account to proceed further. |
||||
|
||||
### Advance procedures |
||||
|
||||
- Arduino Client for MQTT - It's the [PubSubClient](https://github.com/knolleary/pubsubclient), install it to Arduino IDE. If you have the latest version already, this step does not need. |
||||
- Create a channel on ThingSpeak. |
||||
- Get the Channel API Keys from ThingSpeak, put its keys to the sketch. |
||||
|
||||
You can sign up with the [ThingSpeak sign-up page](https://thingspeak.com/users/sign_up). (You are entrusted with the final judgment of account creation for ThingSpeak. Create an account at your own risk.) And you can learn about other steps from the [explanation page](https://hieromon.github.io/AutoConnect/examples/index.html#advance-procedures) of this example. |
||||
|
||||
### Obtaining the keys you need |
||||
|
||||
A mqttRSSI requires the following three key data. After completing the above preparation you should be able to get the three key data. Specify those key data to the `value` in each element of the `param.json` file in the `data` folder. |
||||
|
||||
#### Channel ID |
||||
|
||||
```json |
||||
{ |
||||
"name": "channelid", |
||||
"type": "ACInput", |
||||
"value": "", |
||||
"label": "Channel ID" |
||||
} |
||||
``` |
||||
|
||||
#### User API key |
||||
|
||||
```json |
||||
{ |
||||
"name": "userkey", |
||||
"type": "ACInput", |
||||
"value": "", |
||||
"label": "User Key" |
||||
} |
||||
``` |
||||
|
||||
#### Write API key |
||||
|
||||
```json |
||||
{ |
||||
"name": "apikey", |
||||
"type": "ACInput", |
||||
"value": "", |
||||
"label": "API Key" |
||||
} |
||||
``` |
||||
|
||||
### Sketch data upload |
||||
|
||||
To `param.json` file upload to ESP8266/ESP32 flash memory, you need use the plugin tools as sketch data uploader. You can get one (or both) of the plugins below and upload the `param.json` file to the module. |
||||
|
||||
- [Arduino ESP8266 filesystem uploader](https://github.com/esp8266/arduino-esp8266fs-plugin) |
||||
- [Arduino ESP32 filesystem uploader](https://github.com/me-no-dev/arduino-esp32fs-plugin) |
Loading…
Reference in new issue