WireOS - /anki folder

This is where the personality code for WireOS exists.

For the entire OS, check out the wire-os repo. This repo, wire-os-victor, is a submodule of that, and just builds the /anki folder which goes into that OS. However, wire-os-victor can still be built standalone and deployed to a robot which is running a good base OTA. This is recommended for developers.

Most changes happen in this repo. If one wants to, for instance, add a new feature; this is where they'd do it.

If you want to add a program to the OS, do that in wire-os.

Check vector-docs for more information about the source code leak, what we can do with this, and general Vector info.

What is WireOS?

WireOS serves as a stable, up-to-date, easily-buildable base for CFW, and is a continuation of Anki's work.

Any feature added here should be somewhat objectively applicable to other CFW. Feel free to make a PR. Wire encourages PRs which add things like 3rd-party library upgrades, new behaviors which Anki might have planned to add, code documentation, and optimizations. Wire discourages PRs which significantly alter the experience, like transforming him into a (soulless) GPT box or making him into Cozmo. If you want to do something like that, make your own CFW (instructions in vector-docs).

Building

wire-os-victor can be built standalone on most Linux distros (arm64 or amd64), and on macOS (arm64 only, for now).

Docker is recommended for now (especially if you have a weird or old Linux distro installed), though bare metal works nicely too.

Note that if you have built in Docker before and want to build on bare metal now (or vice-versa), you should do a clean build.

Click an option below for instructions.

Docker: x86_64 or arm64 Linux

• Prerequisites: Make sure you have docker and git installed.

1. Clone the repo and cd into it:

cd ~
git clone --recurse-submodules https://github.com/os-vector/wire-os-victor
cd wire-os-victor

2. Make sure you can run Docker as a normal user. This will probably involve:

sudo groupadd docker
sudo gpasswd -a $USER docker
newgrp docker
sudo chown root:docker /var/run/docker.sock
sudo chmod 660 /var/run/docker.sock

3. Run the build script:

cd ~/wire-os-victor
./build/build-v.sh

Bare Metal: x86_64 or arm64 Linux

• Prerequisites:
  • glibc 2.27 or above - this means anything Ubuntu 18.04 and newer will work.
  • The following packages need to be installed: git wget curl openssl ninja g++ gcc pkg-config ccache

# Arch Linux:
sudo pacman -S git wget curl openssl ninja gcc pkgconf ccache
# Ubuntu/Debian:
sudo apt-get update && sudo apt-get install -y git wget curl openssl ninja-build gcc g++ pkg-config ccache
# Fedora
sudo dnf install -y git wget curl openssl ninja-build gcc gcc-c++ pkgconf-pkg-config ccache

1. Clone the repo and cd into it:

cd ~
git clone --recurse-submodules https://github.com/os-vector/wire-os-victor
cd wire-os-victor

2. Source setenv.sh:

source setenv.sh

3. (OPTIONAL) Run this so you don't have to perform step 2 every time:

echo "source \"$(pwd)/setenv.sh\"" >> $HOME/.bashrc

4. Build:

vbuild

macOS (M-series only)

• Prereqs: Make sure you have brew installed.
  • Then: brew install ccache wget upx ninja

1. Clone the repo and cd into it:

cd ~
git clone --recurse-submodules https://github.com/os-vector/wire-os-victor
cd victor

2. Run the build script:

cd ~/wire-os-victor
./build/build-v.sh

Deploying

1. Install WireOS on your robot.
2. Get your robot's IP through CCIS:

• 1. Place your robot on the charger
• 2. Double click the button
• 3. Lift the lift up then down
• 4. Write down the IP address somewhere
• 5. Lift the lift up then down again to exit CCIS

3. One of the following:

(Docker: x86_64 or arm64 Linux) or (macOS M-series)

macOS BUILDING IS NOT WORKING AT THE MOMENT. THIS WILL BE FIXED SOON.

• Run:

./build/deploy-v.sh

Bare Metal: x86_64 or arm64 Linux

• Run:

vdeploy

Cleaning

99% of the time, if you're working on a behavior or something, you don't need to clean any build directories. The CMakeLists are correctly setup to properly rebuild the code which needs to be rebuilt upon a file change.

If you do want to clean anyway:

(Docker: x86_64 or arm64 Linux) or (macOS M-series)

• Run:

./build/clean.sh

Bare Metal: x86_64 or arm64 Linux

• Run:

vclean