文档/Arduino/libraries/AutoConnect/examples/mqttRSSI

File OriginalPic	EditTime	Size
data	2023-11-05 00:20:13	707 B
mqttRSSI.ino	2023-02-02 17:07:13	20.34 KB
README.md	2023-02-02 17:07:11	4.58 KB

## 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/howtoembed.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.

The mqttRSSI equips with a custom Web page for configuring broker parameters. You can invoke the MQTT Setting web interface from the AutoConnect menu to configure for the mqtt broker performed on Thingspeak. This custom Web page is written in JSON and embedded in the sketch. Also, the [mqttRSSI_FS](https://github.com/Hieromon/AutoConnect/tree/master/examples/mqttRSSI_FS) example stores the JSON document in the flash of ESP8266/ESP32 module and separates it completely from the sketch. Instructions and the APIs for equipping custom Web pages are available in the [documentation](https://hieromon.github.io/AutoConnect/acintro.html). (This example requires [ArduinoJson](https://github.com/bblanchon/ArduinoJson) version 5 or version 6 library.)

The [ThingSpeak](https://thingspeak.com/)™ 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.
- Register the ESP module as an MQTT device to a ThingSpeak channel, allowing it to be published and subscribed to on the channel.
- Get the Channel API Keys and MQTT device credentials from ThingSpeak, and put its keys to the Sketch.

You can sign up with the [ThingSpeak sign-up page](https://thingspeak.com/login). (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/howtoembed.html#used-with-mqtt-as-a-client-application) 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.

#### Server

```json
{
  "name": "mqttserver",
  "type": "ACInput",
  "value": "mqtt3.thingspeak.com"
}
```

#### User API key

Set the User API Key to value of **"value"** key. The User API Key can be found on the **My Profile** page of your ThingSpeak account.

```json
{
  "name": "apikey",
  "type": "ACInput",
  "value": ""
}
```

#### Channel ID

Set the MQTT channel ID you created with ThingSpeak to value of **"value"** key. The Channel ID can be found on the **My Channels** page of your ThingSpeak account.

```json
{
  "name": "channelid",
  "type": "ACInput",
  "value": ""
}
```

#### Write API key

Set the MQTT channel ID you created with ThingSpeak to value of **"value"** key. The Write API Key is located in the **API Key** tag that you can navigate from the **My Channels** page.

```json
{
  "name": "writekey",
  "type": "ACInput",
  "value": ""
}
```

#### Client ID

Set the Client ID of your ESP module that registered MQTT Device of your ThingSpeak account to value of **"value"** key.

```json
{
  "name": "clientid",
  "type": "ACInput",
  "value": ""
}
```

#### Username

Set the Username of your ESP module that registered MQTT Device of your ThingSpeak account to value of **"value"** key.

```json
{
  "name": "username",
  "type": "ACInput",
  "value": ""
}
```

#### Password

Set the Password of your ESP module that registered MQTT Device of your ThingSpeak account to value of **"value"** key.

```json
{
  "name": "password",
  "type": "ACInput",
  "value": ""
}
```

### 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)

垃圾盘

Home / 文档 / Arduino / libraries / AutoConnect / examples / mqttRSSI