tidbyt

module
v0.0.0-...-b132378 Latest Latest
Warning

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

Go to latest
Published: Jun 2, 2021 License: MIT

README

Tidbyt

WARNING This is an early version of this client. It's functional, however, the structure and methods could change substantially.

This is an unofficial client for the Tidbyt API. It uses gRPC reflection to get proto definitions for the services the API exposes and generates a client using protoc.

If there are official implementations released, this will either be updated to utilize those clients or be deleted as unnecessary.

Example

Check out cmd/example-device-details/main.go for an example of using the client. To run the program as is, set your device details as environment variables and run the following:

export TIDBYT_DEVICE_ID="<device-id>"
export TIDBYT_AUTH_TOKEN="<auth-token>"
go run cmd/example-device-details/main.go

Regenerate Client

To regenerate the client (you likely don't need to do this), run the following:

export TIDBYT_DEVICE_ID="<device-id>"
export TIDBYT_AUTH_TOKEN="<auth-token>"
./scripts/gen-proto.sh

See the script comments for more information about the assumptions it's making.

Directories

Path Synopsis
api
cmd
pkg
tidbyt
Package tidbyt provides a helpful client to the Tidbyt API.
Package tidbyt provides a helpful client to the Tidbyt API.

Jump to

Keyboard shortcuts

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