Skip to content

Commit

Permalink
host => broker_host + add platform_name spec (#65)
Browse files Browse the repository at this point in the history 
* host => broker_host + add platform_name spec

* broker_host => broker + platform_name => platform

---------

Co-authored-by: Damien Albisson <UF205DAL@net.elsys-design.com>
  • Loading branch information
@Darcraytore1
Darcraytore1 and Damien Albisson authored May 21, 2024
1 parent bb0fe5f commit 28bd180
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions content/docs/platform/specifications/connection-info/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,13 @@ The file **must** be structured as follow:

```json
{
"host": {
"broker": {
"addr": "localhost",
"port": 1883
},
"platform": {
"name": "panduza_platform"
},
"credentials": {
"user": "foo",
"pass": "xxxxxxxxxx"
Expand All @@ -45,14 +48,15 @@ The file **must** be structured as follow:
}
```

| Field | Description | Type | Default | Mandatory |
| ---------------------- | ---------------------------------------------------------------------------- | --------------- | ----------- | --------- |
| `host/addr` | MQTT broker IP address or hostname | String | "localhost" | True |
| `host/port` | MQTT broker port | Integer | 1883 | True |
| `credentials/user` | Username | String | "" | False |
| `credentials/pass` | Password | String | "" | False |
| `services/retry_delay` | Delay between 2 broker connection retry (in seconds)<br> `-1` == never retry | Integer / Float | 1 | False |
| `services/enable_plbd` | Enable Panduza Local Broker Discovery | Boolean | true | False |
| Field | Description | Type | Default | Mandatory |
| ----------------------------- | ---------------------------------------------------------------------------- | --------------- | ------------------ | --------- |
| `broker/addr` | MQTT broker IP address or hostname | String | "localhost" | True |
| `broker/port` | MQTT broker port | Integer | 1883 | True |
| `platform/name` | Platform name | String | "panduza_platform" | False |
| `credentials/user` | Username | String | "" | False |
| `credentials/pass` | Password | String | "" | False |
| `services/retry_delay` | Delay between 2 broker connection retry (in seconds)<br> `-1` == never retry | Integer / Float | 1 | False |
| `services/enable_plbd` | Enable Panduza Local Broker Discovery | Boolean | true | False |

### `[REQ_CONN_INFO_0025_00]` - Log connection information at platform boot

Expand Down

0 comments on commit 28bd180

Please sign in to comment.