Skip to content

Latest commit

 

History

History
130 lines (77 loc) · 3.65 KB

max.pod

File metadata and controls

130 lines (77 loc) · 3.65 KB
Raw

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 loop switch '/usr/local/bin/set-gpio'
max loop switch '/usr/local/bin/%s-my-boiler' enable disable

max watch

DESCRIPTION

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

Usage: max [<loop|watch> [<interval>]] [<subcommand> <args> \; <subcommand> <args> \; ...)

Modifiers

When the first argument is loop or watch, the subcommands are repeated every interval seconds. If no interval is specified, it will default to 10 seconds.

loop will add an empty line between the outputs, watch will clear the screen before each subcommand.

Subcommands

When no subcommand is given, summary is used.

Multiple subcommands can be specified by separating them by a ;. Note that the ; will probably need escaping or quoting (e.g. \; or ';') and must be an argument by itself, i.e. separated by whitespace on the shell command line.

config <device_id|room_id|type|all> display <setting>

Configures which temperature the thermostat should display: either the setpoint or the current.

config <device_id|room_id|type|all> temperatures <comfort> <eco> <max> <min>

temperatures may be abbreviated as temp.

Configures the comfort ("day") and eco ("night") presets, and the limits for the on-device temperature control.

To keep the current value for any of these temperatures, provide 0 or ''. When fewer than 4 numbers are given, the remaining ones default to keeping the current value.

crosslink <room_id>

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.

forget <device_id>

Unpair a specific device.

set <room_id|all> <temperature|eco|comfort>

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 list of rooms with values from the room's devices.

status

Outputs a summary of device attributes, grouped by room.

mqtt <hostname> <topic_prefix>

Publishes device attributes to the given MQTT server. Currently does not support any authentication or TLS. The topic_prefix should not end in /, as one is added by the program.

The messages are sent with the retain flag enabled, and consist of the numeric decimal value, a space, and the corresponding unit.

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_id|device_id> <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/>

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 24:

Unterminated C< ... > sequence