vector-bluetooth

README

vector bluetooth

Primarily, this is meant to be a set of libraries to connect to vector via BLE. It just so happens that there's also a CLI that utilizes them built in.

Prerequisites.

1. You'll need to install libsodium for your OS. Specific instructions vary by OS

Running on Linux

To build the binary, run

$ make build

You'll have to do something like this on the built binary

$ sudo setcap 'cap_net_raw,cap_net_admin+eip' /path/to/file

Running on OS X

Completely untested, but let me know!

Running on Windows

Currently unavailable in Windows- there are no Go wrappers for Bluetooth in Windows due to the way Bluetooth is handled by Windows, hence why this is not implemented yet.

CLI

There are more features in the library than are currently available in the CLI, but here's whats currently available

Name	Description
scan	runs a BLE scan and displays an appropriate list of devices
connect	connect to a vector via ID (displayed in the scan)
authorize	performs a cloud authorization (but you'll need to find your token- via SSH in your robot, do "cat /data/data/com.anki.victor/persistent/token/token.jwt")
configure	allows you to make/change configuration
get-status	displays the status of your vector
wifi-scan	scan for a list of available wifi networks
wifi-connect	connect to a wifi network
wifi-forget	tell vector to forget a wifi network
wifi-ip	display IP information of the robot
ota-start	perform an OTA code download
ota-cancel	stops an in-progress OTA download
logs	download logs from your robot

Configuration Options

Name	Description
Timezone	Input a valid timezone. A handy list of timezone options are listed under the "TZ Database Name" column on Wikipedia
Default Location	Input a valid location. Format is /<State (if applicable)>/
Locale	Determines wake word ("Hey Vector") accent detection. Available options are listed in the list_locales file.
Data Analytics	Set to "true" to allow Vector to upload crash logs and other non-personal logs to DDL. Note: This data is not sold or released to any third party.
Distance Units	Set to "true" to measure distance in metric units. Set to "false" to measure distance in imperial units.
Temperature Units	Set to "true" to measure temperature in metric units. Set to "false" to measure distance in imperial units.

Project status

This is an early release, and not all features are implemented in either the CLI or in the library itself.