switchbot-cli

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

Install

Prerequisites

• Install Rust if it's not installed yet.

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 as command line arguments, as well as environment variables SWITCHBOT_TOKEN and SWITCHBOT_SECRET.

Interactive Mode

The switchbot command enters the interactive mode when no arguments are specified. Please see the Batch Mode section if you are looking for non-interactive usage.

$ switchbot
1: Hub Mini AF (Hub Mini, ID:111222333)
2: Bedroom Light (DIY Light, ID:444555666)
3: Living Fan (Fan, ID:777888999)
...
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.

Quit

Hit the Enter key twice, or enter q to quit the interactive mode.

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: Bedroom Light (DIY Light, ID:444555666)
3: Living Fan (Fan, ID:777888999)
...
Device> 2
Name: Bedroom Light
ID: 444555666
Type: DIY Light
Command>

Multiple Devices

It is possible to select multiple devices at once by specifying multiple numbers or device IDs separated by , (comma). This is handy when you want to send the same command to multiple devices at once, such as turning off all devices.

Device> 2,3

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 device number 2.

Device> 2
Name: 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. Both commands and devices can be aliased.

switchbot -a fan=777888999 -a hot=fanSpeed:100 -a lights=2,5,6
switchbot fan hot lights on

To remove existing aliases, please omit the value.

switchbot -a hot

Status

To check the status of your devices, enter status. The output depends on the device type. Please refer to the SwitchBot API documentation about device status for the details of the status for each device type.

Command> status
power: "off"
fanSpeed: 23

Status of a Key

It is also possible to check the status of a specific key by specifying status. (status dot) followed by the key name. For example, the following command shows the power status of the selected device.

Command> status.power
"off"

If-Command

The conditional "if" command allows you to send different commands depending on the device status. This capability allows you to create a command to toggle device statuses. The following example turns off the device if the power status is on, and turns it on otherwise.

Command> if/power=on/off/on

When multiple devices are selected, the first device is used to determine which command to execute. Then the command is executed on all selected devices. This is to make the behaviors consistent across multiple devices.

switchbot 4,2 if/power=on/off/on

In the Batch Mode example above, if the device 4 is on, both the device 2 and 4 are turned off, regardless of the power status of the device 2. If you want to toggle multiple devices independently, you can specify the if-command for each device.

switchbot 4 if/power=on/off/on 2 if/power=on/off/on

Aliases can make it easier to type, as shown in the example below.

switchbot -a t=if/power=on/off/on 4 t 2 t

[!NOTE] If the / (slash) is used in the device name or the command, other non-alphanumeric characters can be used as the separator, as long as all separators are the same character.

switchbot 4 if.power=on.off.on

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 commands as arguments. This is useful to create your own batch files, or to use with launcher applications such as Elgato Stream Deck.

switchbot 1 on

You can also specify multiple devices and commands.

switchbot 1 on setMode:101 4,6 off

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

Getting the device status in the batch mode is also possible.

switchbot 4,6 status.battery

This example prints the battery status of the device 4 and 6.

Change History

Please see the release notes for the change history.