|
| 1 | +# Configuration Files |
| 2 | +Each application module designed to work with configuration files for easier manipulation to server-side changes. A configuration file is named as `config.json` and stores necessary connection parameters which are designed for you to easily connect to the applications. |
| 3 | + |
| 4 | +In this file, you can find example configuration files for each application module and their mandatory and optional parameters. This file must be placed on the root directory of PicoLTE module. |
| 5 | + |
| 6 | +## Table of Contents |
| 7 | +1. [Amazon Web Services IoT Core](#amazon-web-services-iot-core-configurations) |
| 8 | +2. [Microsoft Azure IoT Hub](#microsoft-azure-iot-hub-configurations) |
| 9 | +3. [Slack](#slack-configurations) |
| 10 | +4. [Telegram](#telegram-configurations) |
| 11 | +5. [ThingSpeak™](#thingspeak-configurations) |
| 12 | +6. [Native HTTPS](#https-configurations) |
| 13 | +7. [Native MQTTS](#mqtts-configurations) |
| 14 | +8. [Configuration Files for Your Own Application Module](#configuration-files-for-your-own-application-module) |
| 15 | + |
| 16 | +## Applications |
| 17 | +In this section, we're going to give you better understanding about how to create a `config.json` file for specific application modules. |
| 18 | + |
| 19 | +### Amazon Web Services IoT Core Configurations |
| 20 | +You can select MQTTS or HTTPS protocol and delete the other attribute. |
| 21 | +```json |
| 22 | +{ |
| 23 | + "aws": { |
| 24 | + "mqtts": { |
| 25 | + "host": "[YOUR_AWSIOT_ENDPOINT]", |
| 26 | + "port": "[YOUR_AWSIOT_MQTT_PORT]", |
| 27 | + "pub_topic": "[YOUR_MQTT_TOPIC]", |
| 28 | + "sub_topics": [ |
| 29 | + "[YOUR_MQTT_TOPIC/1]", |
| 30 | + "[YOUR_MQTT_TOPIC/2]" |
| 31 | + ] |
| 32 | + }, |
| 33 | + |
| 34 | + "https": { |
| 35 | + "endpoint": "[YOUR_AWS_IOT_ENDPOINT]", |
| 36 | + "topic": "[YOUR_DEVICE_TOPIC]" |
| 37 | + } |
| 38 | + } |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +### Microsoft Azure IoT Hub Configurations |
| 43 | +Within this level of configurations, you can use Azure IoT Hub directly. |
| 44 | +```json |
| 45 | +{ |
| 46 | + "azure": { |
| 47 | + "hub_name": "[YOUR_IOT_HUB_NAME]", |
| 48 | + "device_id": "[YOUR_DEVICE_ID]" |
| 49 | + } |
| 50 | +} |
| 51 | +``` |
| 52 | +For more detailed configuration, you may want to use extra MQTTS parameters. Each attribute in MQTTS is optional. |
| 53 | +```json |
| 54 | +{ |
| 55 | + "azure": { |
| 56 | + "hub_name": "[YOUR_IOT_HUB_NAME]", |
| 57 | + "device_id": "[YOUR_DEVICE_ID]", |
| 58 | + "mqtts": { |
| 59 | + "host":"[YOUR_MQTT_HOST]", |
| 60 | + "port":"[YOUR_MQTT_PORT]", |
| 61 | + "pub_topic":"[YOUR_MQTT_PUB_TOPIC]", |
| 62 | + "sub_topics":[ |
| 63 | + ["[YOUR_MQTT_TOPIC/1]",[QOS]], |
| 64 | + ["[YOUR_MQTT_TOPIC/2]",[QOS]] |
| 65 | + ], |
| 66 | + "username":"[YOUR_MQTT_USERNAME]", |
| 67 | + "password":"[YOUR_MQTT_PASSWORD]" |
| 68 | + } |
| 69 | + } |
| 70 | +} |
| 71 | +``` |
| 72 | + |
| 73 | +### Slack Configurations |
| 74 | +To connect Slack, only need is a WebHook URL, there is no more detailed attributes. |
| 75 | + |
| 76 | +```json |
| 77 | +{ |
| 78 | + "slack":{ |
| 79 | + "webhook_url": "[INCOMING_WEBHOOK_URL]" |
| 80 | + } |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +### Telegram Configurations |
| 85 | +Within this level of configurations, you can use Telegram directly. |
| 86 | +```json |
| 87 | +{ |
| 88 | + "telegram": { |
| 89 | + "token": "[YOUR_BOT_TOKEN_ID]", |
| 90 | + "chat_id": "[YOUR_GROUP_CHAT_ID]" |
| 91 | + } |
| 92 | +} |
| 93 | +``` |
| 94 | +In case of future server URL changes in Telegram side, you may want to add `server` attribute as shown below. |
| 95 | +```json |
| 96 | +{ |
| 97 | + "telegram": { |
| 98 | + "server": "[TELEGRAM_BOT_API_ENDPOINT]", |
| 99 | + "token": "[YOUR_BOT_TOKEN_ID]", |
| 100 | + "chat_id": "[YOUR_GROUP_CHAT_ID]" |
| 101 | + } |
| 102 | +} |
| 103 | +``` |
| 104 | + |
| 105 | + |
| 106 | +### ThingSpeak Configurations |
| 107 | +Within this level of configurations, you can use ThingSpeak directly. Subscription and publish operations are made directly to all channel fields. |
| 108 | +```json |
| 109 | +{ |
| 110 | + "thingspeak": { |
| 111 | + "channel_id": "[YOUR_CHANNEL_ID]", |
| 112 | + "mqtts": { |
| 113 | + "client_id": "[DEVICE_MQTT_CLIENT_ID]", |
| 114 | + "username": "[DEVICE_MQTT_USERNAME]", |
| 115 | + "password": "[DEVICE_MQTT_PASSWORD]" |
| 116 | + } |
| 117 | + } |
| 118 | +} |
| 119 | +``` |
| 120 | +For better control on which fields to subscribe or publish, you may want to add extra attributes. Also, please note that host and port address can be change by its own attributes. |
| 121 | +```json |
| 122 | +{ |
| 123 | + "thingspeak": { |
| 124 | + "channel_id": "[YOUR_CHANNEL_ID]", |
| 125 | + "mqtts": { |
| 126 | + "host": "[THINGSPEAK_HOST_ADDRESS]", |
| 127 | + "port": "[THINGSPEAK_PORT_ADDRESS]", |
| 128 | + "client_id": "[DEVICE_MQTT_CLIENT_ID]", |
| 129 | + "username": "[DEVICE_MQTT_USERNAME]", |
| 130 | + "password": "[DEVICE_MQTT_PASSWORD]", |
| 131 | + "sub_topics": [ |
| 132 | + ["[YOUR_MQTT_TOPIC]", [QOS]] |
| 133 | + ], |
| 134 | + "pub_topic": "[YOUR_MQTT_TOPIC]" |
| 135 | + } |
| 136 | + } |
| 137 | +} |
| 138 | +``` |
| 139 | +## Modules |
| 140 | +Some use-cases can be implemented by using modules when there is no spesific application for that use-case. In this situtations, the developers can built their own solutions with using HTTPS and MQTTS modules. |
| 141 | + |
| 142 | +### HTTPS Configurations |
| 143 | +```json |
| 144 | +{ |
| 145 | + "https": { |
| 146 | + "server": "[HTTP_SERVER]", |
| 147 | + "username": "[YOUR_HTTP_USERNAME]", |
| 148 | + "password": "[YOUR_HTTP_PASSWORD]" |
| 149 | + } |
| 150 | +} |
| 151 | +``` |
| 152 | +### MQTTS Configurations |
| 153 | +```json |
| 154 | +{ |
| 155 | + "mqtts": { |
| 156 | + "host": "[YOUR_MQTT_HOST]", |
| 157 | + "port": "[YOUR_MQTT_PORT]", |
| 158 | + "pub_topic": "[YOUR_MQTT_PUB_TOPIC]", |
| 159 | + "sub_topics": [ |
| 160 | + ["[YOUR_MQTT_TOPIC/1]",[QOS]], |
| 161 | + ["[YOUR_MQTT_TOPIC/2]",[QOS]] |
| 162 | + ], |
| 163 | + "username": "[YOUR_MQTT_USERNAME]", |
| 164 | + "password": "[YOUR_MQTT_PASSWORD]" |
| 165 | +} |
| 166 | +``` |
| 167 | + |
| 168 | +## Configuration Files for Your Own Application Module |
| 169 | +The most important feature that we've developed in PicoLTE SDK is the ability to create new applications for your specific services. Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines. You need to follow standarts that we used to create an application configuration parameters. |
| 170 | + |
| 171 | + This is the general structure of a `config.json` file: |
| 172 | + ``` |
| 173 | + { |
| 174 | + "your_own_app": { |
| 175 | + [application_specific_attributes], |
| 176 | + // If the connection made with MQTTS: |
| 177 | + "mqtts": { |
| 178 | + "host": "", |
| 179 | + "port": "", |
| 180 | + "pub_topic": "", |
| 181 | + "sub_topics": [ |
| 182 | + ["", [QOS]], |
| 183 | + ["", [QOS]] |
| 184 | + ], |
| 185 | + "username": "", |
| 186 | + "password": "" |
| 187 | + }, |
| 188 | + // If the connection made with HTTPS: |
| 189 | + "https": { |
| 190 | + "server": "", |
| 191 | + "username": "", |
| 192 | + "password": "" |
| 193 | + } |
| 194 | + } |
| 195 | + } |
| 196 | + ``` |
| 197 | + In case of redundant parameter in MQTTS or HTTPS, you can remove it from the structure. |
0 commit comments