From d62d42ab11a862babcd5286c572b1fc56205c6b5 Mon Sep 17 00:00:00 2001 From: Xavier RODRIGUEZ Date: Mon, 24 Jun 2024 08:13:25 +0200 Subject: [PATCH] structuring new attribute types --- .../mqtt-panduza/attribute-types/index.md | 45 +++++++++++++++++++ .../mqtt-panduza/interfaces/registers.md | 10 ++--- 2 files changed, 50 insertions(+), 5 deletions(-) create mode 100644 content/docs/50_platform/specifications/mqtt-panduza/attribute-types/index.md diff --git a/content/docs/50_platform/specifications/mqtt-panduza/attribute-types/index.md b/content/docs/50_platform/specifications/mqtt-panduza/attribute-types/index.md new file mode 100644 index 0000000..4475827 --- /dev/null +++ b/content/docs/50_platform/specifications/mqtt-panduza/attribute-types/index.md @@ -0,0 +1,45 @@ +--- +title: "Attribute Types" +weight: 100 +description: "" +icon: cloud +--- + +### `[PLATF_00018]` - Attribute A0 + +Historic attribute type for Panduza. + +- Commands sent on topic "cmds/set" +- Acknowledge on reading the topic "atts/{att_name}" + +Payloads: json + +Its main goal was to be able to set multiple attributes with the same command. It supported only a "control" vision of Panduza. +This type should be avoided for new interfaces. + +### `[PLATF_00019]` - Attribute A1 + +Attributes for field control + +Similar to A0 but with a dedicated cmds topic + +- Commands sent on topic "cmds/{att_name}" +- Acknowledge on reading the topic "atts/{att_name}" + +Payloads: json + +atts topic: retained true ! + +cmds and atts are mirroring, to set a value just send it into cmds and atts will reflect if accepted. + +Some fields or all felds can be ReadOnly. + +### `[PLATF_00020]` - Attribute A2 + +free cmds (send command on the custom format defined by the interface) + +### `[PLATF_00020]` - Attribute A3 + +free atts (value returned on the custom format defined by the interface) + +atts topic: retained true ! diff --git a/content/docs/50_platform/specifications/mqtt-panduza/interfaces/registers.md b/content/docs/50_platform/specifications/mqtt-panduza/interfaces/registers.md index da67c4a..842a2ed 100644 --- a/content/docs/50_platform/specifications/mqtt-panduza/interfaces/registers.md +++ b/content/docs/50_platform/specifications/mqtt-panduza/interfaces/registers.md @@ -53,11 +53,11 @@ To read 3 register from index 0 ## Attributes -| Attribute name | Retain Topic | -| :------------- | :----------: | -| map | true | -| settings | true | -| commands | true | +| Name | Type | +| :------------- | :--: | +| map | A3 | +| settings | A1 | +| commands | A2 | ### `[PLATF_00016_00]` - map