Bolay's Wiki

User Tools

Site Tools

Trace:
operating_systems:linux:debian:acdsn-c-fx

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
Last revisionBoth sides next revision
operating_systems:linux:debian:acdsn-c-fx [2012/11/19 14:23] – external edit 127.0.0.1operating_systems:linux:debian:acdsn-c-fx [2012/11/26 13:58] – [Options] sbolay
Line 1: Line 1:
-====== ACDSN-AC-FX ======+====== ACDSN-C-FX ======
 The following line shows how to address and The following line shows how to address and
 communicate with a NiX1 slave over a RS485 line. communicate with a NiX1 slave over a RS485 line.
Line 15: Line 15:
 ===== Commands ===== ===== Commands =====
 ^ Label     ^ Command ^ ^ Label     ^ Command ^
-|[[#delete]]| D       | 
 |[[#new]]   | N       | |[[#new]]   | N       |
 |[[#query]] | Q       | |[[#query]] | Q       |
  
 ===== Arguments ===== ===== Arguments =====
-==== Delete ==== 
-^ Label        ^ Arguments ^ Options ^ Comments ^ 
-| format       | a         ||| 
-| delete key   | k         |||  
-| delete right | r         |||  
-| restart      | s         ||| 
-| delete unit  | u         |||  
-| delete user  | x         |||  
- 
 ==== New ==== ==== New ====
-^ Label                    ^ Arguments ^ Options                 ^ Comments              ^ +^ Label                    ^ Arguments ^ Options                   ^ Comments                                                ^ 
-| new address              | a         | <address>               | 1-65535 - cannot be broadcasted | +| new address              | a         | <address>                 | change address                                          | 
-| new bad access timeout   | b         | <timeout>               | 1-255 | +| new buzzer mode          | b         | <mode>                    | buzzer activated or not                                 | 
-| new valid access timeout | c         | <timeout>               | 1-255 |  +| new contact mode         | c         | <contact>\t<mode>         | set contact NO/NC mode                                  |  
-| new key            | k         | <key>                   || +| new discontinuation    | d         | <discontinuation>         | set the timeout value after which the slave consider itself to be abandoned by the server| 
-| new lock                 | l         | <device>\t<lock>        | device (1-2) locked (1) or not (0)|  +| new limit                | l         | <ow>\t<limitH>\t<limitL>  | set alarm boundaries                                    |  
-| new mode                 | m         | <device>\t<mode>        | slave (0) or device (1-9) active (0) or not (0) |  +| new mode                 | m         | 0\t<mode>                 | slave enable/disable                                    | 
-| new rights               | r         | <user>\t<unit>\t<right> ||  +| :::                      | :::       | <contact>\t<mode>         | contact enable/disable                                  | 
-| new status & log rotation| s         | -                       ||  +| :::                      | :::       | <ow>\t<mode>              | OW device enable/disable                                |  
-| new timestamp            | t         | <timestamp>             | only if RTC defined (used to synchronize clock) |  +| new recess               | r         | <recess>                  | scan-rate interval                                      |  
-| new unit                 | u         | <>\t<>||  +| new timestamp            | t         | <timestamp>               | only if RTC defined (used to synchronize clock)         |  
-| new overdrive speed      | v         | <device>\t<overdrive>   | put 1-wire devices in overdrive speed | +| new wire                 | w         | -                         | scan the lines and return the number of OW device found | 
-| new wire                 | w         | -                       ||  +
-| new user                 | x         | <uid>                   ||  +
-| new baudrate             | z         | <baudrate>              || +
  
 ==== Query ==== ==== Query ====
-^ Label                      ^ Arguments ^ Options ^ Comments                   ^ +^ Label                        ^ Arguments ^ Options ^ Comments                     ^ 
-| query general status       | a         ||| +| query buzzer status          | b         ||| 
-| query bad access timeout   | b         ||| +| query contact status         | c         ||| 
-| query valid access timeout | c         ||| +| query discontinuation status | d         |             | no query from server timeout | 
-| query entry                | e         ||| +| query family                 | f         | <ow>        | get the 1-wire family of device n | 
-| query family               | f         |         | 1-wire family              | +| query mode                   | m         | 0 (zero)    | slave active or not   | 
-| query secret key           | k         ||| +| :::                          | :::       | <contact>   | contacts active or not | 
-| query lock                 | l         ||| +| :::                          | :::       | <ow>        | OW devices active or not | 
-| query mode                 | m         |         | slave/device active or not | +| query recess                 | r         |             | scan-rate intervall          | 
-| query rights               | r         ||| +| query status                 | s         | 0 (zero)    | global status | 
-| query status               | s         ||| +| :::                          | :::       | <contact>   | contacts status | 
-| query timestamp            | t         |         | only if RTC is defined     |  +| :::                          | :::       | <ow>        | OW devices status | 
-| query unit                 | u         |||  +| query timestamp              | t         |             | only if RTC is defined       |  
-| query overdrive speed      | v         ||| +| query value                  | v         ||| 
-| query wire                 | w         ||| +| query wire                   | w         | 0 (zero)    | tel the number of OW devices connected | 
-| query user                 | x         ||| +| :::                          | :::       | <ow>        | return the OW SID            |
- +
-===== Configuration Files ===== +
- +
-The configuration files are flat text file where each fields are separated by a tabulation. +
- +
-==== keys.txt ==== +
- +
-Contains the list of the key used to hash the credentials on the iButton key. You can generate a new key every day and add it to this file, the most recent key comming first. +
- +
-^ Field Name ^ Description                                               ^ Example                    ^ +
-| timestamp  | The timestamp of the time when the key has been generated | 1350028169                 | +
-| key        | The value of the secret key                               | [Z}4V;qr$(/Kc_aiF7#K8tATNC | +
- +
-<file txt demo_keys.txt> +
-1350028169      [Z}4V;qr$(/Kc_aiF7#K8tATNC +
-1349094539      IdRPKslg\?/ +
-1349085044      9YxUJ`wa#\U;M18=L,>_bo8wIbn"IoY +
-1349085044      cl8b]It3f,F-b +
-1349085044      ad15lMR{*]P_<koY&=@;cNgr +
-</file> +
- +
-==== units.txt ==== +
- +
-Provides a link beetween the unit id and a human readable label. +
- +
-^ Field Name ^ Description                                               ^ Example     ^ +
-| id         | The unique identifier of the unit, as used in slaves.conf | 2           | +
-| label      | A human description of the unit                           | Main Office | +
- +
-<file txt demo_units.txt> +
-1       Reception +
-2       Main Office +
-3       CEO's Office +
-</file> +
- +
-==== users.txt ==== +
- +
-Contains the list of all users, the timestamp of the last key read from the user and a value which can be incremented +
-when an iButton key is lost or if the data on the iButton key has been copied by some nasty people. +
- +
-^ Field Name ^ Description                                                  ^ Example     ^ +
-| id         | The unique identifier the the user, as used in cron.txt      | Arthur Dent | +
-| timestamp  | The timestamp of the last key read for the user              | 1350028169  | +
-| increment  | A value which can be incremented when an iButton key is lost | 3           | +
- +
-<file txt demo_users.txt> +
-Arthur Dent             1350028169      3 +
-Ford Prefect            1349085044      2 +
-Zaphod Beeblebrox       1349085044      5 +
-</file>+
  
-==== cron.txt ==== 
  
-Contains the rights to access on some unit for a user during a specified time interval (specified as a cron).+===== Options ===== 
 +^ Options               ^ Comments ^ 
 +|<address>              | 0 to 65535                                  | 
 +|<contact>              | 1 or 2                                      | 
 +|<limitH>               | Higher alarm limit                          | 
 +|<limitL>               | Lower alarm limit                           | 
 +|<mode>                 | 0 [disable] or 1 [enable]                   | 
 +|<ow>                   | OW devices ranges from 3 to the number of OW devices detected on line | 
 +|<recess>               | 0 to 180 [seconds]                          | 
 +|<timestamp>            | 0 to 9'999'999'999 [seconds since 1.1.1970] |
  
-^ Field Name ^ Description                                                  ^ Example      ^ 
-| unit_id    | The number identifying the target unit of this rule          | 1            | 
-| user_id    | The identifier of the user on which this rule applies        | Arthur Dent  | 
-| cron       | The cron value of the accessible periods for this rule       | 0 8-17 * * * | 
  
-<file txt demo_cron.txt> 
-1       Arthur Dent     0 8-17 * * * 
-2       Arthur Dent     0 8-17 * * * 
-1       Ford Prefect    * * * * * 
-</file> 
-