@@ -24,7 +24,7 @@ To properly work, this device needs:
...
@@ -24,7 +24,7 @@ To properly work, this device needs:
| Name | Type | Description |
| Name | Type | Description |
| ---- | ---- | ----------- |
| ---- | ---- | ----------- |
| ContactKey | String | The key for which to modify the value in PANIC Phonebook. |
| 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 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 /><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/>
<br/><br/>
...
@@ -35,7 +35,7 @@ Every attributes are at OPERATOR Level.
...
@@ -35,7 +35,7 @@ Every attributes are at OPERATOR Level.
| panicPhonebookReady | no | Scalar | READ | DEV_BOOLEAN | Whether PANIC Phonebook was found. |
| 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. |
| 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/>
<br/><br/>
...
@@ -56,7 +56,7 @@ Every commands are at OPERATOR Level.
...
@@ -56,7 +56,7 @@ Every commands are at OPERATOR Level.
| Name | Description |
| Name | Description |
| ---- | ----------- |
| ---- | ----------- |
| ALARM | Device failed to update PANIC Phonebook or to init PyAlarm devices. |
| ALARM | Device failed to update PANIC Phonebook or to init PyAlarm devices. |
| FAULT | ContactList property is not correcty set. |
| FAULT | `ContactList` property is not correcty set. |
| INIT | Device is initializing, parsing its properties and checking PANIC phonebook availability.<br/>In this state, you are not authorized to read `panicPhonebookReady` attribute, nore to read or set `contact` attribute. |
| INIT | Device is initializing, parsing its properties and checking PANIC phonebook availability.<br/>In this state, you are not authorized to read `panicPhonebookReady` attribute, nore to read or set `contact` attribute. |
| MOVING | Writing PANIC Phonebook and initializing PyAlarm devices.<br/>In this state, you are not authorized to set `contact` attribute. |
| MOVING | Writing PANIC Phonebook and initializing PyAlarm devices.<br/>In this state, you are not authorized to set `contact` attribute. |