Skip to content

Latest commit

 

History

History
82 lines (48 loc) · 1.93 KB

max.pod

File metadata and controls

82 lines (48 loc) · 1.93 KB

NAME

max - Simple shell interface for the eQ-3 MAX! Cube LAN Gateway

SYNOPSIS

max summary

max pair 42
max crosslink 42
max set 42 18.0
max dump

max switch '/usr/local/bin/set-gpio'
max switch '/usr/local/bin/%s-my-boiler' enable disable

DESCRIPTION

For instructions and examples, please refer to the main documentation in the README.md file of this distribution.

Subcommands

When no subcommand is given, summary is used.

For each of the devices in a room, commands the device to link with each of the other devices in that room.

dump

Outputs a debug dump of the internal state after conncting

pair <room_id>

Initiates the pairing of a new device and configures the device's room id.

set <room_id> <temperature>

Sends a new temperature to the devices in a room, forcing the mode to manual. Specify all instead of a numeric room ID to set the temperature everywhere.

summary

Outputs a summary of device attributes, grouped by room.

switch <command> [<on> <off>]

Determines whether there is a demand for heat, and runs the given shell command accordingly. command is a sprintf-like format and should only contain a single %s placeholder. Any other % character should be escaped as %%. If no %s is given, it is added at the end so that it becomes a command line argument.

on defaults to 1, off defaults to 0.

name <room|device> <name>

Sets the name for a room (numeric id) or device (6 digit hexadecimal id) and writes the metadata back to the Cube.

reboot

Reboots the Cube.

Environment variables

MAX_HOST

Can be set to the hostname or IPv4 address of the Cube to disable automatic discovery.

LICENSE

Pick your favourite OSI approved license :)

http://www.opensource.org/licenses/alphabetical

AUTHOR

Juerd Waalboer <#####@juerd.nl> <http://juerd.nl/>