Vector SDK

https://keriganc.com/sdkdocs
Admin
The Vector SDK provides direct access to Vector robot's advanced sensors, AI capabilities, and...
Tokens:53,834
Snippets:381
Trust Score:0.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Navigate to Tutorials Sub-directory

Source: https://keriganc.com/sdkdocs/_sources/getstarted.rst

This command changes the current working directory to the 'tutorials' sub-directory within the SDK examples. This directory contains the 'Hello, World!' program used for the initial setup test.

```Shell
cd tutorials
```

--------------------------------

### Navigate to Vector SDK Examples Directory

Source: https://keriganc.com/sdkdocs/_sources/getstarted.rst

This command changes the current working directory to the main directory where the Anki Vector SDK example programs are extracted. This is a prerequisite for running any of the SDK examples.

```Shell
cd anki_vector_sdk_examples
```

--------------------------------

### Navigate to Tutorials Sub-directory

Source: https://keriganc.com/sdkdocs/getstarted

Instructions to change the current working directory to the 'tutorials' sub-directory, which is located within the SDK examples folder and contains the 'Hello, World!' program.

```Shell
cd tutorials
```

--------------------------------

### Navigate to Vector SDK Examples Directory

Source: https://keriganc.com/sdkdocs/getstarted

Instructions to change the current working directory in the terminal or command prompt to the location where the Vector SDK example programs have been extracted.

```Shell
cd anki_vector_sdk_examples
```

--------------------------------

### Execute Vector 'Hello, World!' Python Program

Source: https://keriganc.com/sdkdocs/_sources/getstarted.rst

These commands demonstrate how to run the 'Hello, World!' Python program for the Anki Vector SDK on different operating systems. The program instructs Vector to say 'Hello, World!' and can optionally accept a robot serial number for multi-robot setups.

```Shell
./01_hello_world.py
```

```Shell
python3 01_hello_world.py
```

```Shell
py 01_hello_world.py
```

```Shell
./01_hello_world.py --serial {robot_serial_number}
```

--------------------------------

### Execute 'Hello, World!' Program

Source: https://keriganc.com/sdkdocs/getstarted

Commands to run the basic 'Hello, World!' Python program, which instructs Vector to say 'Hello, World!'. This snippet includes variations for different operating systems and an option to specify a particular robot by its serial number.

```Shell
./01_hello_world.py
```

```Shell
python3 01_hello_world.py
```

```Shell
py 01_hello_world.py
```

```Shell
./01_hello_world.py --serial {robot_serial_number}
```

--------------------------------

### Install wire-pod Vector SDK

Source: https://keriganc.com/sdkdocs/_sources/install-macos.rst

Installs the wire-pod compatible Vector SDK for the current user. This is the primary command to get the SDK set up on your system.

```Shell
python3 -m pip install --user wirepod_vector_sdk
```

--------------------------------

### Install Wire-Pod Vector SDK (Python)

Source: https://keriganc.com/sdkdocs/install-windows

Install the wirepod_vector_sdk using pip. The --user flag installs the package in the user's home directory, avoiding system-wide changes and potential permission issues.

```Python
py -m pip install --user wirepod_vector_sdk
```

--------------------------------

### Upgrade pip and setuptools for Python package installation

Source: https://keriganc.com/sdkdocs/_sources/troubleshooting.rst

Instructions to upgrade the pip installer and setuptools to resolve issues with Python package installations, particularly on macOS, Linux, and Windows. This helps prevent common installation errors like 'AttributeError: '_NamespacePath' object has no attribute 'sort''.

```Python
pip3 install -U pip
```

```Python
python -m pip install --upgrade pip
```

```Python
py -3 -m pip install --upgrade pip
```

```Python
pip install --upgrade setuptools
```

--------------------------------

### Install wirepod_vector_sdk (Python)

Source: https://keriganc.com/sdkdocs/_sources/install-windows.rst

Installs the wirepod_vector_sdk for the Vector robot using pip, making it available for the current user.

```Python
py -m pip install --user wirepod_vector_sdk
```

--------------------------------

### Upgrade Python Setuptools (Troubleshooting)

Source: https://keriganc.com/sdkdocs/install-windows

Another common troubleshooting step for SDK installation errors is to upgrade Python Setuptools. Setuptools is crucial for building, distributing, and installing Python packages.

```Python
py -3 -m pip install --upgrade setuptools
```

--------------------------------

### Upgrade Python setuptools

Source: https://keriganc.com/sdkdocs/troubleshooting

Command to upgrade the `setuptools` package, which is essential for building and distributing Python packages. Upgrading it can resolve specific errors like `AttributeError: '_NamespacePath' object has no attribute 'sort'` during package installations.

```bash
pip install --upgrade setuptools
```

--------------------------------

### Upgrade Python pip installer

Source: https://keriganc.com/sdkdocs/troubleshooting

Provides commands to upgrade the `pip` package installer on different operating systems. This is a crucial step to resolve various Python package installation issues, ensuring compatibility and access to the latest features.

```bash
pip3 install -U pip
```

```powershell
python -m pip install --upgrade pip
```

```powershell
py -3 -m pip install --upgrade pip
```

--------------------------------

### Install wirepod_vector_sdk and 3D Viewer (Python 3.11 and above)

Source: https://keriganc.com/sdkdocs/install-linux

These commands install the wirepod_vector_sdk for Python 3.11 and newer versions. The `--break-system-packages` flag is included for compatibility. The second command optionally installs the 3D viewer component.

```bash
python3 -m pip install --break-system-packages --user wirepod_vector_sdk

python3 -m pip install --break-system-packages --user wirepod_vector_sdk[3dviewer]
```

--------------------------------

### Upgrade Wire-Pod Vector SDK (Python)

Source: https://keriganc.com/sdkdocs/install-windows

To upgrade an existing wirepod_vector_sdk installation, use the pip install command with the --user and --upgrade flags. This updates the SDK to its latest version while preserving user-specific installation.

```Python
py -m pip install --user --upgrade wirepod_vector_sdk
```

--------------------------------

### Upgrade pip Package Manager (Python)

Source: https://keriganc.com/sdkdocs/_sources/install-windows.rst

Upgrades the pip package installer to its latest version, which can resolve dependency or installation issues encountered during SDK setup.

```Python
python -m pip install --upgrade pip
py -3 -m pip install --upgrade pip
```

--------------------------------

### Install wirepod_vector_sdk

Source: https://keriganc.com/sdkdocs/install-macos

This command installs the wirepod_vector_sdk for the Vector robot into the user's Python environment using pip. The --user flag ensures installation to the user's site-packages directory.

```python
python3 -m pip install --user wirepod_vector_sdk
```

--------------------------------

### Configure Vector SDK Robot Authentication (Python)

Source: https://keriganc.com/sdkdocs/_sources/install-windows.rst

Executes the SDK's configuration utility to establish a connection with the Vector robot. It prompts for robot and wire-pod details, downloading necessary authentication tokens and certificates for access.

```Python
py -m anki_vector.configure
```

--------------------------------

### Install wirepod_vector_sdk (Ubuntu 22.04)

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Commands to install the `wirepod_vector_sdk` Python package for the Vector robot on Ubuntu 22.04. The second command includes an optional `[3dviewer]` extra to install dependencies required for the 3D viewer functionality.

```Python
python3 -m pip install --user wirepod_vector_sdk
```

```Python
python3 -m pip install --user wirepod_vector_sdk[3dviewer]
```

--------------------------------

### Install zeroconf for Anki Vector mDNS Discovery (Bash)

Source: https://keriganc.com/sdkdocs/advanced-tips

Provides the command to install the `zeroconf` Python package. This package is a prerequisite for enabling automatic mDNS discovery, which allows the Anki Vector SDK to locate the robot on new or changed WiFi networks.

```Bash
pip3 install --user zeroconf
```

--------------------------------

### Upgrade Python Setuptools (Python)

Source: https://keriganc.com/sdkdocs/_sources/install-windows.rst

Upgrades the Python setuptools package, often required to fix issues during SDK installation or when encountering build-related errors.

```Python
py -3 -m pip install --upgrade setuptools
```

--------------------------------

### Configure Vector SDK Authentication (Python)

Source: https://keriganc.com/sdkdocs/install-windows

Run the anki_vector.configure module to authenticate the SDK with your Vector robot. This process prompts for robot details and wire-pod instance IP, downloading necessary authentication tokens and certificates for robot access.

```Python
py -m anki_vector.configure
```

--------------------------------

### Install freeglut Library for OpenGL

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl

Instructions for installing the freeglut library, an OpenGL Utility Toolkit implementation, which is required for the 3D viewer. Commands are provided for Linux, and guidance for Windows users to download the DLL.

```Shell
sudo apt-get install freeglut3
```

```Shell
On Windows: Go to http://freeglut.sourceforge.net/ to get a freeglut.dll file. It’s included in any of the Windows binaries downloads. Place the DLL next to your Python script, or install it somewhere in your PATH to allow any script to use it.
```

--------------------------------

### Upgrade Python Pip (Troubleshooting)

Source: https://keriganc.com/sdkdocs/install-windows

If you encounter errors during SDK installation, upgrading pip to its latest version can often resolve dependency or installation issues. This ensures you have the most recent package installer.

```Python
python -m pip install --upgrade pip
```

```Python
py -3 -m pip install --upgrade pip
```

--------------------------------

### Install wirepod_vector_sdk (Arch Linux)

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Commands to install the `wirepod_vector_sdk` Python package for the Vector robot on Arch Linux with Python 3.11 and above. The `--break-system-packages` flag is used, and an optional `[3dviewer]` extra can be included to install dependencies for the 3D viewer.

```Python
python3 -m pip install --break-system-packages --user wirepod_vector_sdk
```

```Python
python3 -m pip install --break-system-packages --user wirepod_vector_sdk[3dviewer]
```

--------------------------------

### Install wirepod_vector_sdk and 3D Viewer (Python 3.10 and below)

Source: https://keriganc.com/sdkdocs/install-linux

These commands install the wirepod_vector_sdk for Python 3.10 and earlier versions. The second command optionally installs the 3D viewer component, enabling graphical visualization features.

```bash
python3 -m pip install --user wirepod_vector_sdk

python3 -m pip install --user wirepod_vector_sdk[3dviewer]
```

--------------------------------

### Uninstall Previous Vector SDK Versions (Python)

Source: https://keriganc.com/sdkdocs/install-windows

Before installing the new SDK, it's recommended to uninstall any previously installed Vector SDK versions (anki_vector, ikkez_vector, cyb3r_vector_sdk) using pip to avoid conflicts and ensure a clean installation.

```Python
py -m pip uninstall anki_vector
py -m pip uninstall ikkez_vector
py -m pip uninstall cyb3r_vector_sdk
```

--------------------------------

### Configure Vector SDK Authentication

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Command to run the Vector SDK's configuration utility. This interactive script prompts the user for the robot's name, IP address, serial number, and the wire-pod instance's IP address, then downloads necessary authentication tokens and certificates to `~/.anki_vector`.

```Python
python3 -m anki_vector.configure
```

--------------------------------

### Connect to Vector using mDNS Discovery (Python)

Source: https://keriganc.com/sdkdocs/advanced-tips

Demonstrates how to connect to an Anki Vector robot using mDNS discovery. This method allows the SDK to automatically find the robot even if its IP address changes, simplifying network transitions. It requires the `zeroconf` package to be installed.

```Python
import anki_vector

with anki_vector.Robot(name="Vector-A1B2") as robot:
    # The sdk will try to connect to 'Vector A1B2',
    # even if its IP address has changed.
    pass
```

--------------------------------

### Upgrade wirepod_vector_sdk

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Command to upgrade an existing installation of the `wirepod_vector_sdk` Python package to its latest version. The `--break-system-packages` flag is included for compatibility with newer Python environments, and `--user` ensures installation in the user's directory.

```Python
python3 -m pip install --break-system-packages --user --upgrade wirepod_vector_sdk
```

--------------------------------

### Install freeglut Library for OpenGL Viewer

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_viewer

Instructions for installing the `freeglut` library, a required OpenGL Utility Toolkit implementation, on Linux systems. macOS/OSX typically has a compatible library preinstalled. For Windows, users must manually download `freeglut.dll` from freeglut.sourceforge.net and place it in their system PATH or next to their Python script.

```shell
sudo apt-get install freeglut3
```

--------------------------------

### Install Python and Pip on Ubuntu 22.04

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Commands to update system package lists and install Python 3, pip (Python package installer), and the Tkinter library (python3-pil.imagetk) on an Ubuntu 22.04 Linux system. These are essential prerequisites for running the Vector SDK.

```Bash
sudo apt-get update
sudo apt-get install python3
```

```Bash
sudo apt install python3-pip
```

```Bash
sudo apt-get install python3-pil.imagetk
```

--------------------------------

### Install Anki Vector SDK 3D Viewer on Windows

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_vector

Command to install the `wirepod_vector_sdk` with 3D viewer support for Windows environments using pip. This ensures all necessary Python dependencies for OpenGL rendering are met.

```bash
py -3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

--------------------------------

### Configure Vector Robot Authentication

Source: https://keriganc.com/sdkdocs/_sources/install-macos.rst

Initiates the authentication process for connecting to the Vector robot. This command prompts for robot details (name, IP, serial) and wire-pod instance IP, then downloads necessary authentication tokens and certificates to establish a secure connection.

```Shell
python3 -m anki_vector.configure
```

--------------------------------

### Upgrade wirepod_vector_sdk (Python)

Source: https://keriganc.com/sdkdocs/_sources/install-windows.rst

Upgrades an existing wirepod_vector_sdk installation to the newest version, ensuring access to the latest features and bug fixes.

```Python
py -m pip install --user --upgrade wirepod_vector_sdk
```

--------------------------------

### Install freeglut on Linux

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_vector

Command to install the freeglut library, a required OpenGL Utility Toolkit implementation, on Linux systems using apt-get. This is essential for the 3D viewer functionality.

```bash
sudo apt-get install freeglut3
```

--------------------------------

### Install Python 3, pip, and Tkinter on Ubuntu

Source: https://keriganc.com/sdkdocs/install-linux

These commands update package lists and install Python 3, the Python package installer (pip), and Tkinter (Pillow ImageTk) which is often required for graphical Python applications, on Ubuntu Linux.

```bash
sudo apt-get update
sudo apt-get install python3

sudo apt install python3-pip

sudo apt-get install python3-pil.imagetk
```

--------------------------------

### Install Python Dependencies for Anki Vector 3D Viewer

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_viewer

Provides commands to install the necessary Python packages for the Anki Vector SDK's 3D viewer functionality. This includes PyOpenGL and Pillow, which are bundled within the `wirepod_vector_sdk[3dviewer]` extra. Instructions are provided for both Mac/Linux and Windows platforms.

```shell
python3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

```shell
py -3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

--------------------------------

### Uninstall Previous Vector SDKs (Python)

Source: https://keriganc.com/sdkdocs/_sources/install-windows.rst

Commands to remove older or conflicting Vector SDK installations using pip, ensuring a clean environment for the new SDK.

```Python
py -m pip uninstall anki_vector
py -m pip uninstall ikkez_vector
py -m pip uninstall cyb3r_vector_sdk
```

--------------------------------

### Install Python 3D Viewer SDK Dependencies

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl

Commands to install the necessary Python packages for the 3D viewer SDK, including PyOpenGL and Pillow, using pip. Specific commands are provided for Mac/Linux and Windows environments.

```Shell
python3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

```Shell
py -3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

--------------------------------

### Update Homebrew Package Manager

Source: https://keriganc.com/sdkdocs/_sources/install-macos.rst

Updates the Homebrew package manager to ensure all installed packages are up to date before proceeding with new installations.

```Shell
brew update
```

--------------------------------

### Install Python 3 via Homebrew

Source: https://keriganc.com/sdkdocs/_sources/install-macos.rst

Installs the latest version of Python 3 using Homebrew. The Vector SDK requires Python 3.9 or a later version for compatibility.

```Shell
brew install python3
```

--------------------------------

### Install Anki Vector SDK 3D Viewer on Mac/Linux

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_vector

Command to install the `wirepod_vector_sdk` with 3D viewer support for macOS and Linux environments using pip. This ensures all necessary Python dependencies for OpenGL rendering are met.

```bash
python3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

--------------------------------

### Upgrade wirepod_vector_sdk

Source: https://keriganc.com/sdkdocs/install-linux

This command upgrades an existing installation of the wirepod_vector_sdk to its latest version. The `--break-system-packages` flag ensures compatibility with newer Python environments.

```bash
python3 -m pip install --break-system-packages --user --upgrade wirepod_vector_sdk
```

--------------------------------

### Authenticate Anki Vector Robot via SDK

Source: https://keriganc.com/sdkdocs/install-linux

This Python command initiates the interactive authentication process for the Anki Vector robot. It prompts the user for robot details (name, IP address, serial number) and the IP address of a wire-pod instance, then automatically downloads authentication tokens and certificates required for robot access.

```python
python3 -m anki_vector.configure
```

--------------------------------

### Set Permissions for Anki Vector Configuration Folder

Source: https://keriganc.com/sdkdocs/install-linux

These commands ensure that the user has appropriate read, write, and execute permissions for the '.anki_vector' configuration folder and its contents. This step is crucial for the SDK to access and store authentication data correctly.

```bash
sudo chmod +rwx ~/.anki_vector
sudo chown -R $USER ~/.anki_vector
```

--------------------------------

### Set .anki_vector Directory Permissions for Authentication

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Commands to ensure the user has appropriate read, write, and execute permissions for the `~/.anki_vector` directory. This directory is used by the SDK to store authentication credentials and robot configuration files, making proper permissions crucial for successful authentication.

```Bash
sudo chmod +rwx ~/.anki_vector
sudo chown -R $USER ~/.anki_vector
```

--------------------------------

### Upgrade wire-pod Vector SDK

Source: https://keriganc.com/sdkdocs/_sources/install-macos.rst

Upgrades an existing installation of the wire-pod Vector SDK to its latest available version. This ensures you have the most recent features and bug fixes.

```Shell
python3 -m pip install --user --upgrade wirepod_vector_sdk
```

--------------------------------

### Install FreeGLUT Library on Linux for OpenGL Viewer

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl

This snippet provides the command to install the freeglut library on Linux systems, which is a necessary dependency for the Anki Vector SDK's OpenGL Viewer.

```Bash
sudo apt-get install freeglut3
```

--------------------------------

### Python Package Installation for Vector SDK 3D Viewer

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl

This snippet provides the `pip` commands required to install the Python dependencies, specifically PyOpenGL and Pillow, for the Anki Vector SDK's 3D viewer component. These commands are tailored for both macOS/Linux and Windows environments.

```Python
python3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

```Python
py -3 -m pip install --user "wirepod_vector_sdk[3dviewer]"
```

--------------------------------

### Uninstall Previous Vector SDK Versions (Ubuntu 22.04)

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Commands to uninstall any previously installed versions of the Anki Vector SDK, including `anki_vector`, `ikkez_vector`, and `cyb3r_vector_sdk` packages. This ensures a clean installation environment for the `wirepod_vector_sdk` on Ubuntu 22.04.

```Python
python3 -m pip uninstall -y anki_vector
python3 -m pip uninstall -y ikkez_vector
python3 -m pip uninstall -y cyb3r_vector_sdk
```

--------------------------------

### Authenticate Vector Robot with wire-pod

Source: https://keriganc.com/sdkdocs/install-macos

This command initiates the authentication process for the Vector robot. It prompts the user for robot details (name, IP, serial number) and the wire-pod instance IP, then downloads necessary authentication tokens and certificates for access.

```python
python3 -m anki_vector.configure
```

--------------------------------

### Module Attributes of anki_vector.opengl.opengl_viewer

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_viewer

Documents the key module-level attributes provided by `anki_vector.opengl.opengl_viewer`. These attributes offer default configurations for OpenGL programs, including window resolution, projector settings, camera object, and light group, facilitating quick setup of 3D scenes.

```APIDOC
Module Attributes:
  default_resolution: A default window resolution provided for OpenGL Vector programs 800x600 is large enough to see detail, while fitting on the smaller end of modern monitors.
  default_projector: A default projector configurate provided for OpenGL Vector programs A Field of View of 45 degrees is common for 3d applications, and a viewable distance range of 1.0 to 1000.0 will provide a visible space comparable with most physical Vector environments.
  default_camera: A default camera object provided for OpenGL Vector programs.
  default_lights: A default light group provided for OpenGL Vector programs.
```

--------------------------------

### Uninstall Previous Vector SDKs (Python 3.11 and above)

Source: https://keriganc.com/sdkdocs/install-linux

For Python 3.11 and newer, use these commands to uninstall any existing Vector SDK installations (anki_vector, ikkez_vector, cyb3r_vector_sdk). The `--break-system-packages` flag is crucial for managing packages in newer Python environments.

```bash
python3 -m pip uninstall --break-system-packages -y anki_vector
python3 -m pip uninstall --break-system-packages -y ikkez_vector
python3 -m pip uninstall --break-system-packages -y cyb3r_vector_sdk
```

--------------------------------

### Connect to Vector using mDNS Discovery

Source: https://keriganc.com/sdkdocs/_sources/advanced-tips.rst

Demonstrates how to automatically discover and connect to an Anki Vector robot using mDNS, even if its IP address changes. This method requires the 'zeroconf' package for discovery.

```python
import anki_vector

with anki_vector.Robot(name="Vector-A1B2") as robot:
    # The sdk will try to connect to 'Vector A1B2',
    # even if its IP address has changed.
    pass
```

```shell
pip3 install --user zeroconf
```

--------------------------------

### Reserve Vector Behavior Control via Command Line

Source: https://keriganc.com/sdkdocs/advanced-tips

This command-line instruction allows users to reserve control of the Anki Vector robot, ensuring it remains still and does not move autonomously between SDK script executions. This state persists until the command-line process is terminated.

```bash
python3 -m anki_vector.reserve_control
```

--------------------------------

### anki_vector.lights Module API Reference

Source: https://keriganc.com/sdkdocs/generated/anki_vector.lights

Detailed API documentation for the `anki_vector.lights` module, including module attributes, functions, and classes for managing Vector's Cube lights.

```APIDOC
Module: anki_vector.lights

Description: Helper routines for dealing with Vector’s Cube lights and colors.

Module Attributes:
  MAX_COLOR_PROFILE: Color profile to get the maximum possible brightness out of each LED.
  green_light: A steady green colored LED light.
  red_light: A steady red colored LED light.
  blue_light: A steady blue colored LED light.
  cyan_light: A steady cyan colored LED light.
  magenta_light: A steady magenta colored LED light.
  yellow_light: A steady yellow colored LED light.
  white_light: A steady white colored LED light.
  off_light: A steady off (non-illuminated LED light).

Functions:
  package_request_params(lights, color_profile)

Classes:
  ColorProfile(red_multiplier, ...)
    Description: Applies transforms to make Vector's Cube lights and colors appear as intended, by limiting maximum channel intensity.
  Light([on_color, off_color, on_period_ms, ...])
    Description: Lights are used with Vector's Cube.
```

--------------------------------

### Update Homebrew Package Manager

Source: https://keriganc.com/sdkdocs/install-macos

This command updates Homebrew, the package manager for macOS, ensuring that all installed formulae and casks are up to date before proceeding with new installations.

```bash
brew update
```

--------------------------------

### Initialize Anki Vector Robot with OpenGL Viewer

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl.opengl_viewer

Demonstrates how to initialize an `anki_vector.Robot` instance, enabling the integrated 3D viewer, 2D camera feed, and various detection features like face and custom object detection, along with navigation map feed. The robot connection is maintained for 10 seconds to allow interaction or observation.

```python
import time

import anki_vector

with anki_vector.Robot(show_viewer=True,
                       show_3d_viewer=True,
                       enable_face_detection=True,
                       enable_custom_object_detection=True,
                       enable_nav_map_feed=True) as robot:
    time.sleep(10)
```

--------------------------------

### Uninstall Existing Vector SDK Versions

Source: https://keriganc.com/sdkdocs/_sources/install-macos.rst

Removes any previously installed versions of the Vector SDK (anki_vector, ikkez_vector, cyb3r_vector_sdk) to prevent potential conflicts before installing the wire-pod specific SDK.

```Shell
python3 -m pip uninstall anki_vector
python3 -m pip uninstall ikkez_vector
python3 -m pip uninstall cyb3r_vector_sdk
```

--------------------------------

### Set ANKI_ROBOT_HOST and VECTOR_ROBOT_NAME Environment Variables

Source: https://keriganc.com/sdkdocs/_sources/advanced-tips.rst

Shows how to set `ANKI_ROBOT_HOST` and `VECTOR_ROBOT_NAME` environment variables. When set, `anki_vector.configure` will automatically pick up Vector's IP and name, avoiding manual input.

```shell
export ANKI_ROBOT_HOST="192.168.42.42"
export VECTOR_ROBOT_NAME=Vector-A1B2
```

--------------------------------

### Uninstall Previous Vector SDK Versions

Source: https://keriganc.com/sdkdocs/install-macos

These commands remove any previously installed versions of the Vector SDK (e.g., anki_vector, ikkez_vector, cyb3r_vector_sdk) to prevent conflicts and ensure a clean installation of the wirepod_vector_sdk.

```python
python3 -m pip uninstall anki_vector
python3 -m pip uninstall ikkez_vector
python3 -m pip uninstall cyb3r_vector_sdk
```

--------------------------------

### Install Python 3 via Homebrew

Source: https://keriganc.com/sdkdocs/install-macos

This command uses Homebrew to install the latest stable version of Python 3, which is a required dependency for the Vector SDK. The SDK supports Python 3.9 or later.

```bash
brew install python3
```

--------------------------------

### Uninstall Previous Vector SDKs (Python 3.10 and below)

Source: https://keriganc.com/sdkdocs/install-linux

Before installing a new version of the Vector SDK, it's recommended to uninstall any previously installed versions (anki_vector, ikkez_vector, cyb3r_vector_sdk) using pip for Python 3.10 and older environments.

```bash
python3 -m pip uninstall -y anki_vector
python3 -m pip uninstall -y ikkez_vector
python3 -m pip uninstall -y cyb3r_vector_sdk
```

--------------------------------

### Set ANKI_ROBOT_HOST and VECTOR_ROBOT_NAME Environment Variables (Bash)

Source: https://keriganc.com/sdkdocs/advanced-tips

Illustrates how to set the `ANKI_ROBOT_HOST` and `VECTOR_ROBOT_NAME` environment variables in Bash. These variables enable the `anki_vector.configure` utility to automatically retrieve the robot's IP address and name, streamlining the configuration process.

```Bash
export ANKI_ROBOT_HOST="192.168.42.42"
export VECTOR_ROBOT_NAME=Vector-A1B2
```

--------------------------------

### anki_vector.audio Module API Reference

Source: https://keriganc.com/sdkdocs/_sources/generated/anki_vector.audio.rst

Reference documentation for the `anki_vector.audio` module, outlining its structure and key components, specifically the `AudioComponent` and `RobotVolumeLevel` classes.

```APIDOC
Module: anki_vector.audio
  Classes:
    - AudioComponent
    - RobotVolumeLevel
```

--------------------------------

### Reserve Vector Behavior Control via Command Prompt

Source: https://keriganc.com/sdkdocs/_sources/advanced-tips.rst

Explains how to reserve Vector's behavior control from the command prompt using a Python module. This makes the robot remain still between SDK scripts until the script or process is exited.

```shell
python3 -m anki_vector.reserve_control
```

--------------------------------

### API Documentation for anki_vector.touch Module

Source: https://keriganc.com/sdkdocs/_sources/generated/anki_vector.touch.rst

Provides an overview of the `anki_vector.touch` module, listing the key classes available for interacting with Anki Vector's touch sensors.

```APIDOC
Module: anki_vector.touch
  Description: Provides classes for interacting with Anki Vector's touch sensors.
  Classes:
    - TouchComponent
    - TouchSensorData
```

--------------------------------

### Uninstall Previous Vector SDK Versions (Arch Linux)

Source: https://keriganc.com/sdkdocs/_sources/install-linux.rst

Commands to uninstall any previously installed versions of the Anki Vector SDK, including `anki_vector`, `ikkez_vector`, and `cyb3r_vector_sdk` packages, specifically for Arch Linux with Python 3.11 and above. The `--break-system-packages` flag is used to manage package installations in newer Python environments.

```Python
python3 -m pip uninstall --break-system-packages -y anki_vector
python3 -m pip uninstall --break-system-packages -y ikkez_vector
python3 -m pip uninstall --break-system-packages -y cyb3r_vector_sdk
```

--------------------------------

### API: ExternalAudioStreamPrepare

Source: https://keriganc.com/sdkdocs/proto

Defines a message for preflight and initialization settings for audio streaming to the robot.

```APIDOC
ExternalAudioStreamPrepare:
  Preflight and initialization for audio streaming to robot
  audio_frame_rate: uint32
    8000 - 16025
  audio_volume: uint32
    0 - 100
```

--------------------------------

### API Documentation for anki_vector.lights Module

Source: https://keriganc.com/sdkdocs/_sources/generated/anki_vector.lights.rst

Comprehensive API reference for the `anki_vector.lights` module, including module attributes, functions, and classes for controlling Anki Vector's lights.

```APIDOC
Module: anki_vector.lights

Module Attributes:
  MAX_COLOR_PROFILE
  green_light
  red_light
  blue_light
  cyan_light
  magenta_light
  yellow_light
  white_light
  off_light

Functions:
  package_request_params()

Classes:
  ColorProfile
  Light
```

--------------------------------

### Upgrade wirepod_vector_sdk

Source: https://keriganc.com/sdkdocs/install-macos

This command upgrades an existing installation of the wirepod_vector_sdk to its latest version. The --upgrade flag ensures that pip replaces the old version with the new one.

```python
python3 -m pip install --user --upgrade wirepod_vector_sdk
```

--------------------------------

### anki_vector.opengl.main Function API Reference

Source: https://keriganc.com/sdkdocs/generated/anki_vector.opengl

This API documentation details the `main` function within the `anki_vector.opengl` module. This function is responsible for initializing and running the 3D Viewer window, accepting parameters like `close_event` and `input_intent_queue` to manage its operation.

```APIDOC
main(close_event, input_intent_queue, ...[, ...])
  Run the 3D Viewer window.
```

--------------------------------

### ExternalInterface GRPC Methods Overview

Source: https://keriganc.com/sdkdocs/proto

A comprehensive list of GRPC methods exposed by the ExternalInterface for direct interaction and control of Anki's Vector robot. Each method's purpose and functionality are briefly described.

```APIDOC
ExternalInterface:
  ProtocolVersion: Checks the supported protocol version by passing in the client version and minimum host version and receiving a response to see whether the versions are supported.
  SDKInitialization: SDK-only message to pass version info for device OS, Python version, etc.
  DriveWheels: Sets the speed and acceleration for Vector's wheel motors.
  PlayAnimationTrigger: Requests that Vector play an animation trigger.
  PlayAnimation: Requests that Vector play an animation.
  ListAnimations: Constructs and returns a list of animations.
  ListAnimationTriggers: Constructs and returns a list of animation triggers.
  MoveHead: Moves Vector's head.
  MoveLift: Moves Vector's lift.
  StopAllMotors: Stop all motor commands requested: MoveHead, MoveLift and DriveWheels.
  DisplayFaceImageRGB: Sets screen (Vector's face) to a solid color.
  EventStream: Streaming events endpoint
  ExternalAudioStreamPlayback: Play audio using Vector's speaker
  BehaviorControl: Integrate with and acquire control of Vector's AI system.
  AssumeBehaviorControl: Acquire control of Vector's AI system.
  CancelFaceEnrollment: 
  RequestEnrolledNames: Get a list of names and their IDs.
  UpdateEnrolledFaceByID: Update the name enrolled for a given face.
  EraseEnrolledFaceByID: Erase the enrollment (name) record for the face with this ID.
  EraseAllEnrolledFaces: Erase the enrollment (name) records for all faces.
  SetFaceToEnroll: 
  EnableMarkerDetection: 
  EnableFaceDetection: 
  EnableMotionDetection: 
  EnableMirrorMode: 
  EnableImageStreaming: 
  IsImageStreamingEnabled: 
  CancelActionByIdTag: Cancel action by id
  GoToPose: Tells Vector to drive to the specified pose and orientation.
  DockWithCube: Tells Vector to dock with a light cube with a given approach angle and distance.
  DriveOffCharger: Drive Vector off the charger.
  DriveOnCharger: Drive Vector onto the charger.
  FindFaces: Make Vector look for faces by turning and angling his head
  LookAroundInPlace: Make Vector look around in place by turning and moving his head
  RollBlock: Make Vector roll his block, regardless of relative position and orientation
  PhotosInfo: Get the photos info.
  Photo: Get a photo by ID.
  Thumbnail: Get a thumbnail by ID.
  DeletePhoto: Delete a photo by ID.
  DriveStraight: Tells Vector to drive in a straight line.
  TurnInPlace: Turn the robot around its current position.
  SetHeadAngle: Tell Vector's head to move to a given angle.
  SetLiftHeight: Tell Vector's lift to move to a given height.
  TurnTowardsFace: Tell Vector to turn towards this face.
  GoToObject: Tell Vector to drive to the specified object.
  RollObject: Tell Vector to roll his cube.
  PopAWheelie: Tell Vector to "pop a wheelie" using his cube.
  PickupObject: Instruct the robot to pick up the supplied object.
  PlaceObjectOnGroundHere: Ask Vector to place the object he is carrying on the ground at the current location.
  SetMasterVolume: Set the Robot's master volume
  UserAuthentication: 
  BatteryState: Check the current state of the battery.
  VersionState: Get the versioning information for Vector.
  SayText: Make Vector speak text.
  ConnectCube: Attempt to connect to a cube. If a cube is currently connected, this will do nothing.
  DisconnectCube: Requests a disconnection from the currently connected cube.
  CubesAvailable: 
  FlashCubeLights: Signal a connected cube to flash its lights using the default cube flash animation.
  ForgetPreferredCube: Forget the robot's preferred cube. This will cause the robot to connect to the cube with the highest RSSI (signal strength) next time a connection is requested. Saves this preference to disk. The next cube that the robot connects to will become its preferred cube.
  SetPreferredCube: Set the robot's preferred cube and save it to disk. The robot will always attempt to connect to this cube if it is available. This is only used in simulation for now.
  DeleteCustomObjects: Causes the robot to forget about custom objects it currently knows about.
  CreateFixedCustomObject: Creates a permanent custom object instance in the robot's world, with no connection to the vision system.
  DefineCustomObject: Creates a custom object with distinct custom marker(s).
  SetCubeLights: Set each of the lights on the currently connected cube based on two rgb values each and timing data for how to transition between them.
  AudioFeed: Request an audio feed from the robot.
  CameraFeed: Request a camera feed from the robot.
  CaptureSingleImage: Request a single image to be captured and sent from the robot.
  SetEyeColor: Set Vector's eye color.
  NavMapFeed: Stream navigation map data.
```

--------------------------------

### anki_vector.camera Module API Reference

Source: https://keriganc.com/sdkdocs/_sources/generated/anki_vector.camera.rst

API documentation for the `anki_vector.camera` module, outlining its structure and the classes it exposes for interacting with the Anki Vector robot's camera system. This includes classes for camera components, configuration, image data, and event handling for new camera frames.

```APIDOC
anki_vector.camera Module:
  Classes:
    CameraComponent
    CameraConfig
    CameraImage
    EvtNewCameraImage
    EvtNewRawCameraImage
```

--------------------------------

### MeetVictorFaceScanStarted

Source: https://keriganc.com/sdkdocs/proto

A message indicating that Vector has initiated a face scan operation, typically as part of the 'Meet Victor' setup process.

```APIDOC
MeetVictorFaceScanStarted
```

--------------------------------

### MeetVictorFaceScanComplete

Source: https://keriganc.com/sdkdocs/proto

A message indicating that Vector has completed a face scan operation, typically as part of the 'Meet Victor' setup process.

```APIDOC
MeetVictorFaceScanComplete
```

--------------------------------

### UserAuthenticationResponse Message Definition

Source: https://keriganc.com/sdkdocs/proto

Outlines the response structure for user authentication, providing the status, a specific code, and a client token GUID.

```APIDOC
UserAuthenticationResponse:
  status: ResponseStatus
  code: UserAuthenticationResponse.Code
  client_token_guid: bytes
```

--------------------------------

### Anki Vector SDK API Module Listing

Source: https://keriganc.com/sdkdocs/_sources/api.rst

This section lists the top-level modules and sub-packages available within the Anki Vector SDK API. These modules provide functionalities for various aspects of robot interaction, including animation, audio, behavior, camera, connection, events, motors, navigation, objects, and more. For detailed information on protobuf objects, refer to the dedicated protobuf documentation.

```APIDOC
anki_vector
anki_vector.animation
anki_vector.annotate
anki_vector.audio
anki_vector.behavior
anki_vector.camera
anki_vector.camera_viewer
anki_vector.color
anki_vector.connection
anki_vector.events
anki_vector.exceptions
anki_vector.faces
anki_vector.lights
anki_vector.mdns
anki_vector.messaging
anki_vector.motors
anki_vector.nav_map
anki_vector.objects
anki_vector.opengl
anki_vector.opengl.opengl
anki_vector.opengl.opengl_vector
anki_vector.opengl.opengl_viewer
anki_vector.photos
anki_vector.proximity
anki_vector.robot
anki_vector.screen
anki_vector.status
anki_vector.touch
anki_vector.user_intent
anki_vector.util
anki_vector.viewer
anki_vector.vision
anki_vector.world
```
Tokens:
Raw