switchbot-cli 0.1.2

A command-line tool for controlling SwitchBot devices using the SwitchBot API.
Documentation

CI-badge crate-badge docs-badge

switchbot-cli

A command-line tool for controlling SwitchBot devices using the SwitchBot API.

Install

Prerequisites

From crates.io

cargo install switchbot-cli

Usages

Authentication

On the first run, the switchbot command prompts to enter the authentication.

$ switchbot
Token>

Please refer to the SwitchBot documentation about how to obtain the token and secret key.

They are saved in your configuration directory to avoid entering them every time. The --clear option clears the saved authentication, and the switchbot command will prompt for the authentication again. The --token and the --secret options are available to specify them explicitly.

Interactive Mode

Once the authentication is done, the interactive mode starts.

$ switchbot
1: Hub Mini AF (Hub Mini, ID:111222333)
2: My Bedroom Light (DIY Light, ID:444555666)
...
Device>

All your devices are listed with a number, the device name you set in the SwitchBot app, the device type, and the device ID.

Select Device

To select the device to interact with, enter either the number or the device ID.

1: Hub Mini AF (Hub Mini, ID:111222333)
2: My Bedroom Light (DIY Light, ID:444555666)
...
Device> 2
Name: My Bedroom Light
ID: 444555666
Type: DIY Light
Command>

Command

To control your devices, you can send commands. The available commands depend on the device type. Please refer to the SwitchBot API documentation about device control commands to find the command you want to send to your devices.

The following example sends the turnOn command to the DIY Light.

Device> 2
Name: My Bedroom Light
ID: 444555666
Type: DIY Light
Command> turnOn

Parameters

If the command you want to send has "command parameters" other than default, append a : (colon) and the command parameters.

Command> setMode:101

Command Type

If the command has a "commandType" other than command, prepend it with a / (slash) as the separator.

Command> customize/button1

Aliases

Some commands have aliases for convenience. For example, on is an alias for turnOn, and off is an alias for turnOff.

Command> on

You can also add your own aliases by the -a option.

switchbot -a safe=setChildLock:1 -a unsafe=setChildLock:0

To remove existing aliases, omit the value.

switchbot -a safe

Quit

Hit the Enter key twice, or enter q to quit the switchbot command.

Batch Mode

It is also possible to run the switchbot command in non-interactive mode by specifying the device number or the device ID and the command as arguments. This is useful to create your own batch files, or to use with launcher applications such as Elgato Stream Deck.

switchbot 1 turnOn

You can also specify multiple devices and commands.

switchbot 1 turnOn setMode:101 4 turnOff

This example turns on the device 1 and set its mode to 101, and turns off the device 4.

Change History

Please see the release notes for the change history.