tub

command module
v0.1.4 Latest Latest
Warning

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

Go to latest
Published: Nov 14, 2024 License: MIT Imports: 12 Imported by: 0

README

BestWay hot tub CLI

A Golang powered CLI for controlling and monitoring BestWay hot tubs

Installation

go install github.com/danawoodman/tub

This provides a tub command that you can use to control your BestWay hot tub (see usage below).

Usage

# view the docs
tub --help

# first, login using your BestWay credentials
# these credentials are stored in your ~/.bestway.yaml file
# and are used to generate API tokens to authenticate with the API
# service that controls your BestWay tub
tub login -u <USERNAME> -p <PASSWORD>

# check your login status
tub whoami

# get the status of your tub (temp, power, etc.)
tub status

# set the temperature of your tub
tub temp 104

# other commands:
tub filter off|on
tub jets off|low|high
tub heat off|on
tub lock off|on
tub power off|on

Development

# using makefile, install the tub CLI to your $GOPATH
make install

Troubleshooting

502 Bad Gateway

The API service (Gizwits) seems to be quite unstable, so sometimes you'll see a 502 Bad Gateway error. If you do, just try running the command again, usually it will work.

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