switchbot

command module
v2.0.0-...-9a4cf3b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2023 License: MIT Imports: 6 Imported by: 0

README

switchbot CLI

about

CLI tool for SwitchBot API(currently available only two commands: list and status)

prepare your keys

  1. get open token and secret key from SwitchBot app (see SwitchBot API Docs)
  2. create config.toml in current directory:
openToken="your open token"
secretKey="your secret key"

build

go build

usage

list: list devices
./switchbot list

will shown like below(JSON array):

[
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Humidifier",
    "enableCloudService": true,
    "hubDeviceId": "000000000000"
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Humidifier",
    "hubDeviceId": "000000000000"
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Plug Mini (JP)",
    "enableCloudService": true
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Meter",
    "enableCloudService": true,
    "hubDeviceId": "HUB_DEVICE_ID"
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Blind Tilt",
    "hubDeviceId": "000000000000",
    "master": true
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Meter",
    "enableCloudService": true,
    "hubDeviceId": "HUB_DEVICE_ID"
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Hub Mini",
    "hubDeviceId": "000000000000"
  },
  {
    "deviceId": "DEVICE_ID",
    "deviceName": "Device Name",
    "deviceType": "Plug",
    "enableCloudService": true,
    "hubDeviceId": "000000000000"
  }
]
status: get device status
./switchbot status device_id [device_id ...]

will shown like below(JSON array):

[{"deviceId":"DEVICE_ID","deviceType":"Meter","hubDeviceId":"HUB_DEVICE_ID","humidity":43,"temperature":24.3,"brightness":{},"battery":100}]

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL