Skip to content
Snippets Groups Projects
Commit 13ddfacb authored by Raphael GIRARDOT's avatar Raphael GIRARDOT
Browse files

README reviewed

parent 0c29f939
No related branches found
No related tags found
No related merge requests found
......@@ -2,6 +2,7 @@
# ContactManager
---
ContactManager is a device intended to manage local contact for DataStorage, updating its reference in PANIC phonebook.
It is published under the [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.en.html)
*(see LICENSE.txt file)*.
......@@ -20,18 +21,22 @@ To properly work, this device needs:
## Attributes
| Name | Dynamic | Attr. type | R/W type | Data type | Level | Description |
| ---- | ------- | ---------- | -------- | --------- | ----- | ----------- |
| panicPhonebookReady | [ ] | Scalar | READ | DEV_BOOLEAN | OPERATOR | Whether PANIC Phonebook was found. |
| contact | [x] | Scalar | READ_WRITE | DEV_ENUM | OPERATOR | What to write in PANIC Phonebook for the key defined in ContactKey property.<br />The effective written value will be the one in ContactList property for which the key matches the selected label in contact attribute.<br /><br />"Unknown" will always be present in enum labels at first index.<br />Setting contact attribute with "Unknown" will have effect neither on PANIC Phonebook, nore on contact read value.<br />contact read value may return "Unknown" when the value in PANIC Phonebook for the key defined in ContactKey property matches no known value, or when this key is not present in PANIC Phonebook. |
Every attributes are at OPERATOR Level.
| Name | Dyn<br/>amic | Attr. type | R/W type | Data type | Description |
| ---- | ------------ | ---------- | -------- | --------- | ----------- |
| panicPhonebookReady | - [ ] | Scalar | READ | DEV_BOOLEAN | Whether PANIC Phonebook was found. |
| contact | - [x] | Scalar | READ_WRITE | DEV_ENUM | What to write in PANIC Phonebook for the key defined in ContactKey property.<br />The effective written value will be the one in ContactList property for which the key matches the selected label in contact attribute.<br /><br />"Unknown" will always be present in enum labels at first index.<br />Setting contact attribute with "Unknown" will have effect neither on PANIC Phonebook, nore on contact read value.<br />contact read value may return "Unknown" when the value in PANIC Phonebook for the key defined in ContactKey property matches no known value, or when this key is not present in PANIC Phonebook. |
## Commands
| Name | Input type | Output type | Level | Description |
| ---- | ---------- |------------ | ----- | ----------- |
| Init | DEV_VOID | DEV_VOID | OPERATOR | This command initializes the device, forcing it to parse its properties and rebuild its attributes. |
| State | DEV_VOID | DEV_STATE | OPERATOR | This command gets the device state (stored in its device_state data member) and returns it to the caller. |
| Status | DEV_VOID | DEV_STRING | OPERATOR | This command gets the device status (stored in its device_status data member) and returns it to the caller. |
Every commands are at OPERATOR Level.
| Name | Input type | Output type | Description |
| ---- | ---------- |------------ | ----------- |
| Init | DEV_VOID | DEV_VOID | This command initializes the device, forcing it to parse its properties and rebuild its attributes. |
| State | DEV_VOID | DEV_STATE | This command gets the device state (stored in its device_state data member) and returns it to the caller. |
| Status | DEV_VOID | DEV_STRING | This command gets the device status (stored in its device_status data member) and returns it to the caller. |
## States
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment