Merge pull request #4 from os-vector/main

upstream stuff

Author: froggitti

documents/1. History/history of anki.md

@@ -18,5 +18,8 @@
 -   April 29th, 2019: Anki announced their liquidation.
 -   May 1st, 2019: Anki officially went out of business.
 -   January 2020: Digital Dream Labs announced that they bought the assets.
--   TODO: recount the misdoings of DDL
--   2024: code leaked and hooray!
+-   TODO: recount the misdoings of DDL in this time
+-   July 2023 - September 2024: DDL servers go down due to them not paying the bill for their AWS instance while they were still taking money from their customers
+-   September 2024: DDL gets new CEO Zack Anton and the servers come up a few weeks later.
+-   2024: `victor` and `vicOS-oelinux` leaked to github with encrypted keys.
+-   April 30th, 2025: Vector's keys get cracked and a unlock ota has been released to convert prod bots into dev bots.

documents/2. Available CFW/1. WireOS.md

@@ -28,4 +28,34 @@ It is based off of the leaked 2.0.1.6076 source code.
     - His camera now has much less trouble with brightly lit objects
 - Rainbow eyes
     - If chosen, his eyes will always cycle through all the hues
-    - (this can be chosen in :8888/demo.html)
+    - (this can be chosen in :8888/demo.html)
+
+## Installation
+
+### Unlocked Prod
+
+In the BLE terminal in recovery, after connecting him to Wi-Fi:
+
+```
+ota-start http://ota.pvic.xyz/vic/latest/dev.ota
+```
+
+### PVT running some sort of dev OTA (like 1.6.0.3331d)
+
+```
+systemctl stop anki-robot.target
+mount -o rw,remount,exec /data
+curl -o /data/update-engine http://ota.pvic.xyz/update-engine
+chmod +rwx /data/update-engine
+/data/update-engine http://ota.pvic.xyz/vic/latest/dev.ota -v
+```
+
+### OSKR
+
+```
+systemctl stop anki-robot.target
+mount -o rw,remount,exec /data
+curl -o /data/update-engine http://ota.pvic.xyz/update-engine
+chmod +rwx /data/update-engine
+/data/update-engine http://ota.pvic.xyz/vic/latest/oskr.ota -v
+```

documents/2. Available CFW/2. Viccyware.md

@@ -6,4 +6,6 @@ Website: [https://viccyware.com](https://viccyware.com/)
 
 ## What does it do?
 
-Viccyware embeds Cozmo animations, sounds, and behaviors, and morphs them into Vector's personality.
+Viccyware embeds Cozmo animations, sounds, and behaviors, and morphs them into Vector's personality while maintaining the charm of both.
+
+Viccyware is available at [froggitti's Dev Vector web setup](https://devsetup.froggitti.net).

documents/2. Available CFW/5. RainbOS.md

@@ -0,0 +1,23 @@
+# RainbOS
+
+RainbOS is an OS created by [GamingTime](https://github.com/gamingtimevr).
+
+RainbOS's purpose is to give GamingTime a way to learn about the world of coding, GitHub, Anki Vector, and tech.
+
+RainbOS is based off of [WireOS](https://github.com/os-vector/wire-os), but with many added features.
+
+## Changes Made
+
+- Colorful or "rainbow" backpack animations.
+  - RainbOS is meant to add some fun color to Anki Vector's build-in backpack lights. Each animation is carefully chosen to represent what emotion or situation Vector is in and reflect that in a fun new way.
+- BlackJack Request to Play
+  - Anki had an old feature in prototype firmware where Vector would request to "Play BlackJack?" You could chose to start a game of BlackJack with Vector by saying yes, or decide to disapoint Vector with a no. Sadly, this feature was taken out before Vector's release. GamingTime added it back, and it is no fully functional once again.
+- Many more small changes, which you can checkout on the [RainbOS Repository](https://github.com/gamingtimevr/new-victor).
+- More to come in the future.
+  - RainbOS is a work-in-progress! As GamingTime's skills and understandings grow, so will the features of RainbOS. Stay tuned for the future!
+
+## Where to Find
+
+You can find all RainbOS related things on its GitHub repository: [RainbOS Repository](https://github.com/gamingtimevr/new-victor).
+
+You can find installation instructions on the GitHub's repository README. A website is coming soon.

documents/3. Software Architecture/partitions.md

@@ -6,8 +6,20 @@ TODO
 
 ## OEM
 
+Mounts to the /factory folder. Contains calibration logs and cloud keys which are used for mTLS.
+
 ## EMR
 
+The EMR partiton (Electronic Medical Record) contains the calibration info of the robot, its ESN, its model number, and its packout status.
+
 ## boot_a and boot_b
 
-## system_a and system_b
+These are the boot partitions. These partitons contain a ramdisk which is loaded which will then load a system partition matching the slot ID you are in.
+
+## system_a and system_b
+
+The partition Vector's full Linux OS exists in, corresponding to the boot slot. Slot a = system_a. Slot b = system_b.
+
+## userdata
+
+Encrypted, mounted to /data. Used to store user information like faces, pictures, and settings.

documents/4. Operating System/os.md

@@ -2,6 +2,8 @@
 
 Vector runs on an embedded Linux image built with Yocto Jethro.
 
+This describes Vector's *original* os. WireOS (and other CFW) uses a newer version of Yocto.
+
 ## What is Yocto?
 
 Yocto is a toolkit for creating your own embedded Linux "distribution".

documents/6. Make Your Own CFW/1. prerequisites.md

@@ -1,4 +1,4 @@
-# Prerequisites
+# i. Prerequisites
 
 Vector's software is complex and monstrous.
 
@@ -8,6 +8,8 @@ Vector's software is complex and monstrous.
     -   For reference, my desktop has:
         -   Ryzen 5 5700X3D
         -   32GB 3200MHz RAM
+    -   My desktop takes ~50 minutes to build a whole OTA from a clean clone.
+        -   Takes much less time (~5 minutes) after first build.
     -   For a comfortable experience, you should have at least 16GB of RAM.
 - A Vector.
     -   You'll need something to test your code on.

documents/6. Make Your Own CFW/2. forking.md

@@ -1,24 +1,20 @@
-# Forking
+# ii. Forking
 
 Fork wire-os and its submodules.
 
 ## How
 
-- Fork these repos. When choosing names, just replace the `wire-os` parts with the name you desire:
+1. Fork these repos. When choosing names, just replace the `wire-os` parts with the name you desire:
     -   [wire-os](https://github.com/os-vector/wire-os)
     -   [wire-os-victor](https://github.com/os-vector/wire-os-victor)
     -   [wire-os-externals](https://github.com/os-vector/wire-os-externals)
-
-- Let's say, for example, we called it `diode-os`, and our GitHub username is diode123. Run in a Linux terminal:
-
-```
+2. Let's say, for example, we called it `diode-os`, and our GitHub username is diode123. Now we have diode123/diode-os, diode123/diode-os-victor, and diode123/diode-os-externals. Run in a Linux terminal:
+```bash
 cd ~
 git clone https://github.com/diode123/diode-os --recursive
 ```
-
-- Replace the wire-os-victor submodule with yours:
-
-```
+3. Replace the wire-os-victor submodule with yours:
+```bash
 cd diode-os
 git rm -f anki/victor
 rm -rf anki/victor .git/modules/anki/victor
@@ -27,5 +23,15 @@ git submodule add https://github.com/diode123/diode-os-victor anki/victor
 git commit -m "new submodule"
 git push
 ```
-
-- You have successfully created diodeOS.
+4. Clone diode-os-victor separately and replace the EXTERNALS submodule.
+```bash
+cd ~
+git clone https://github.com/diode123/diode-os-victor --recursive
+cd wire-os-victor
+git rm -f EXTERNALS .git/modules/EXTERNALS
+rm -rf EXTERNALS
+git commit -m "remove externals"
+git submodule add https://github.com/diode123/diode-os-externals EXTERNALS
+git commit -m "update externals"
+git push
+```

documents/6. Make Your Own CFW/3. how.md

@@ -1,12 +1,47 @@
-# How to Develop
 
-The majority of your changes will probably be in the /anki folder, which is built from diode-os-victor.
+# iii. How to Develop
 
-## Set up your dev environment
+Here, we will perform two steps in one: learning how to make modifications to the code, and how to change the final screen in CCIS which describes what the builds are.
 
-You should have two folders: diode-os-victor and diode-os.
+## What IDE should I use?
 
-Do NOT just make all of you changes in diode-os/anki/victor, despite it being the same repo. `diode-os-victor` can be built standalone, and deployed to a robot with `rsync`. These builds should not end up in a Yocto environment.
+Anki tended to use Visual Studio Code - just use that.
 
-TODO
+## What OS should I use?
 
+An M-series Macs, or an x86_64 Linux PC - toolchains are only available for these platforms.
+
+## Let's make a modification!
+
+1. Open up the diode-os-victor folder in VSCode.
+2. Open up `animProcess/src/cozmoAnim/faceDisplay/faceInfoScreenManager.cpp`
+3. Modify lines 69-72 to match the details of your new CFW.
+4. Open a terminal and run `cd ~/diode-os-victor`
+5. Build the code by running this: `./build/build-v.sh`
+
+## Deploy
+
+When you deploy code to a robot, his /anki folder gets replaced. This can be done on a laptop (reference: Ryzen 7840U, 16GB RAM). You do not need to build a whole OTA every time you want to test a change. ./build/build.sh just builds a /anki folder.
+
+1. Open a terminal and `cd ~/diode-os-victor`
+2. Echo your robot's IP address to robot_ip.txt: `echo "192.168.1.50" > robot_ip.txt`
+3. Run: `curl -o robot_sshkey https://github.com/kercre123/unlocking-vector/raw/refs/heads/main/ssh_root_key`
+4. Deploy: `./build/deploy-v.sh`
+
+## Build an OTA with your change
+
+1. Run `cd ~/diode-os`
+2. Update the submodule: 
+```bash
+cd anki/victor
+git pull origin main
+cd ../../
+git add .
+git commit -m "vp"
+git push
+```
+3. Build:
+```bash
+./build/build.sh -bt dev -v 1
+```
+4. Your OTA will be at: ./_build/vicos-3.0.1.1d.ota.

documents/7. Tips and Tricks/all.md

@@ -0,0 +1,40 @@
+# Tips For All
+
+Tips and tricks for all - beginners, advanced users, and developers.
+
+## Dual booting
+
+Vector technically has three boot slots (boot slot = boot+system partition) - system_a, system_b, and recoveryfs.
+
+We can swap between system_a and system_b.
+
+The bot is in recovery when he is on the anki.com/dev screen. This should not be touched.
+
+Let's say I want to run Viccyware in system_b, and WireOS in system_a. To do this:
+
+1. Install WireOS like normal.
+2. Once booted to WireOS, install Viccyware.
+
+That's it!
+
+Use the `sysswitch` command to swap between them.
+
+If you are using an OS which doesn't have `sysswitch`, do the following to switch:
+
+1. Run `cat /proc/cmdline`
+2. If the output contains `androidboot.slot_suffix=_b` near the end, run `bootctl b set_active a`. If it is `androidboot.slot_suffix=_a`, run `bootctl a set_active b`.
+3. Run `reboot`.
+
+If the bootctl command gives you an errorish output, try `bootctl-anki` instead.
+
+## CCIS
+
+CCIS provides helpful information about Vector's network status, sensors, robot-specific-information like ESN, and OS information.
+
+Do this to get to it:
+
+1. Place Vector on the charger (important)
+2. Double click the button
+3. Lift the lift up then down (you are now in CCIS)
+4. Push the head down then up
+5. Click the button to go through the menus