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

README reviewed

parent 3277e78a
Branches
No related tags found
No related merge requests found
......@@ -23,8 +23,8 @@ 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 /><pre>John:john.doe[]()@synchrotron-soleil.fr<br />Jack:%JACK<br />Telma:telma.louise[]()@synchrotron-soleil.fr</pre><br />With this example, `contact` attribute will have the enum labels [\"Unknown\", \"John\", \"Jack\", \"Telma\"]. |
| **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 /><pre>John:john.doe[]()@synchrotron-soleil.fr<br />Jack:%JACK<br />Telma:telma.louise[]()@synchrotron-soleil.fr</pre><br />With this example, `contact` attribute will have the enum labels [\"Unknown\", \"John\", \"Jack\", \"Telma\"]. |
<br /><br />
......@@ -34,8 +34,8 @@ Every attributes are at OPERATOR Level.
| Name | Dyn<br/>amic | Attr.<br/>type | R/W<br/>type | Data<br/>type | Description |
| ---- | ------------ | -------------- | ------------ | ------------- | ----------- |
| panicPhonebookReady | no | Scalar | READ | DEV_BOOLEAN | Whether PANIC Phonebook was found. |
| contact | yes | 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 /><br />Setting `contact` attribute with "Unknown" *(0)* will have effect neither on PANIC Phonebook, nore on `contact` read value.<br /><br />`contact` read value may return "Unknown" *(0)* 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** | no | Scalar | READ | DEV_BOOLEAN | Whether PANIC Phonebook was found. |
| **contact** | yes | 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 /><br />Setting `contact` attribute with "Unknown" *(0)* will have effect neither on PANIC Phonebook, nore on `contact` read value.<br /><br />`contact` read value may return "Unknown" *(0)* 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. |
<br /><br />
......@@ -45,9 +45,9 @@ 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. |
| **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. |
<br /><br />
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment