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

README reviewed

parent f7a65000
No related branches found
No related tags found
No related merge requests found
......@@ -19,9 +19,7 @@ To properly work, this device needs:
| Name | Type | Description |
| ---- | ---- | ----------- |
| ContactKey | String | The key for which to modify the value in PANIC Phonebook. |
| ContactList | String[] | The contacts this device should know.<br />Each contact should be written this way:<br />Contact_Name:PhoneBook_Value<br /><br />The Contact_Name entries will represent the possible enum labels for contact attribute.<br />The PhoneBook_Value is what to write in PANIC Phonebook at the key defined in ContactKey property when contact attribute is set with Contact_Name.<br /><br />Example:<br />```John:john.doe@synchrotron-soleil.fr
Jack:%JACK
Telma:telma.louise@synchrotron-soleil.fr```<br /><br />With this example, contact attribut will have the enum labels [\"Unknown\", \"John\", \"Jack\", \"Telma\"]. |
| ContactList | String[] | The contacts this device should know.<br />Each contact should be written this way:<br />Contact_Name:PhoneBook_Value<br /><br />The Contact_Name entries will represent the possible enum labels for contact attribute.<br />The PhoneBook_Value is what to write in PANIC Phonebook at the key defined in ContactKey property when contact attribute is set with Contact_Name.<br /><br />Example:<br />`John:john.doe@synchrotron-soleil.fr`<br />`Jack:%JACK`<br />`Telma:telma.louise@synchrotron-soleil.fr`<br /><br />With this example, contact attribut will have the enum labels [\"Unknown\", \"John\", \"Jack\", \"Telma\"]. |
# Attributes
......@@ -29,8 +27,8 @@ 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. |
| 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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment