Detailed Usage

The first point to note is that if any zone is tripped\faulted during the testing of nx584_client, you may notice that the commands will not execute and the alarm panel will not respond to nx584_client commands as you would expect. This is especially notable when issuing 'arm' commands.

Also note, if nx584_server is running on a specific host (as per the above example), then you must use the --host argument as is articulated throughout these examples.

List command help text:

nx584_client -h
nx584_server -h

Display a summary summary of partitions and zone status:

nx584_client summary --host 192.168.1.100:5007

Output version of panel:

nx584_client version --host 192.168.1.100:5007

Tail (follow) realtime logs of nx584_server:

tail -f /home/pi/nx584.log

Show individual zone information:

nx584_client show --host 192.168.1.100:5007 --zone 1

Show individual partition information:

nx584_client show --host 192.168.1.100:5007 --partition 1

Arm alarm

nx584_client arm --partition 1 --host 192.168.1.100:5007

Arm in stay mode

nx584_client arm-stay --host 192.168.1.100:5007

Arm in away mode

nx584_client arm-away --host 192.168.1.100:5007

Disarm alarm

nx584_client --host 192.168.1.100:5007 --master <USER PIN> disarm

Nb. The --master argument does not imply the use of the alarm panels master/installer/program code/pin. Instead, it implies the use of a 'user' code/pin. It is best practice not to use the master code/pin where at all possible. Applying the 'master' role to a user account is likely a better option.

Get user info from panel - Requires user pin that has 'Master' access rights on the panel

nx584_client --host 192.168.1.100:5007 --user 1 --master <USER PIN> getuser

Show events

nx584_client --host 192.168.1.100:5007 --master <USER PIN> events

List all partitions

nx584_client --host 192.168.1.100:5007 --master <USER PIN> partitions

Bypass an individual zone. Nb. User must have access to bypass zones on the panel.

nx584_client --host 192.168.1.100:5007 --master <USER PIN> --zone 2 bypass

Unbypass an individual zone. Nb. User must have access to unbypass zones on the panel.

nx584_client --host 192.168.1.100:5007 --master <USER PIN> --zone 2 unbypass