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

README reviewed

parent 3e050c91
No related branches found
No related tags found
No related merge requests found
......@@ -19,7 +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 /><pre>John:john.doe&#64;synchrotron-soleil.fr<br />Jack:%JACK<br />Telma:telma.louise&#64;synchrotron-soleil.fr</pre><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 /><pre>John:john.doe[]()@synchrotron-soleil.fr<br />Jack:%JACK<br />Telma:telma.louise[]()@synchrotron-soleil.fr</pre><br /><br />With this example, contact attribut will have the enum labels [\"Unknown\", \"John\", \"Jack\", \"Telma\"]. |
# Attributes
......@@ -46,6 +46,6 @@ Every commands are at OPERATOR Level.
| ---- | ----------- |
| ALARM | Device failed to update PANIC Phonebook or to init PyAlarm devices. |
| 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 |
| MOVING | Writing PANIC Phonebook and initializing PyAlarm devices.<br />In this state, you are not authorized to 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. |
| ON | Device is ready to do its job. |
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment