{"id":15144527,"url":"https://github.com/kaiaai/install","last_synced_at":"2025-10-23T22:30:40.884Z","repository":{"id":183819525,"uuid":"670810162","full_name":"kaiaai/install","owner":"kaiaai","description":"Docker files to build Kaia.ai ROS2 images","archived":false,"fork":false,"pushed_at":"2024-09-26T22:59:06.000Z","size":223,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-27T10:41:57.745Z","etag":null,"topics":["arduino-library","docker-image","dockerfile","esp32","esp32-arduino","kaia-ai","micro-ros","micro-ros-esp32","open-source","pet-bot","pets","remake-ai","robot-framework","robot-framework-docker","robotic-pets","robotics","robotics-programming","robots","ros","ros2"],"latest_commit_sha":null,"homepage":"https://kaia.ai","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kaiaai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-25T22:27:04.000Z","updated_at":"2024-09-26T22:59:09.000Z","dependencies_parsed_at":"2024-01-28T14:06:38.625Z","dependency_job_id":"e6374aec-794f-4d5c-a9ac-6e5f1eb35041","html_url":"https://github.com/kaiaai/install","commit_stats":null,"previous_names":["kaiaai/kaia_docker","kaiaai/docker","kaiaai/install"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaiaai%2Finstall","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaiaai%2Finstall/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaiaai%2Finstall/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaiaai%2Finstall/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaiaai","download_url":"https://codeload.github.com/kaiaai/install/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219867717,"owners_count":16555814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino-library","docker-image","dockerfile","esp32","esp32-arduino","kaia-ai","micro-ros","micro-ros-esp32","open-source","pet-bot","pets","remake-ai","robot-framework","robot-framework-docker","robotic-pets","robotics","robotics-programming","robots","ros","ros2"],"created_at":"2024-09-26T10:42:02.087Z","updated_at":"2025-10-23T22:30:40.879Z","avatar_url":"https://github.com/kaiaai.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kaia.ai Docker images\n\n[Kaia.ai](https://kaiaai) is a software platform for ROS2-based pet robots. Please sign up for an early launch invite [here](https://remake.ai).\n\nQuestions? Please visit the [Support Forum](https://github.com/makerspet/support/discussions/)!\n\nThree ways to install:\n- on a Ubuntu 22.04 PC directly - easiest\n- on a Ubuntu or Windows PC using Docker - recommended\n- on a Ubuntu or Windows PC using a virtual machine\n\n## Install on Ubuntu PC directly\nMake sure your Ubuntu version is 22.x\n```\ngit clone --depth 1 https://github.com/kaiaai/install\ncd install/ubuntu\nsource install_ros2_iron_ubuntu_22_04.sh\nsource install_kaiaai_iron_ubuntu_22_04.sh\n```\n\n## Install on a Ubuntu or Windows PC using a virtual machine\n- install [VMware Workstation](https://blogs.vmware.com/workstation/2024/05/vmware-workstation-pro-now-available-free-for-personal-use.html)\n- download a [Ubuntu image](https://ubuntu.com/download/desktop) and create a virtual machine\n- inside the Ubuntu virtual machine\n  - run the Install-on-Ubuntu-PC-directly instructions above\n  - or run install-using-Docker instructions below\n\n## Install on Ubuntu or Windows PC using Docker\n- If you are using a Windows PC, read this [blog post](https://kaia.ai/blog/local-pc-setup-windows/)\n  - install [Windows WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install)\n  - install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/)\n  - install [VcXsrv](https://sourceforge.net/projects/vcxsrv/), launch it and set display to `0` (zero)\n- When using a Linux PC\n  - install [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) or\n[Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) (with GUI)\n\nOn Ubuntu you can run\n```\ngit clone --depth 1 https://github.com/kaiaai/install\ncd install/utils\nsource install_docker_on_ubuntu.sh\n```\n\n\u003ca href=\"http://www.youtube.com/watch?feature=player_embedded\u0026v=XOc5kCE3MC0\" target=\"_blank\"\u003e\n \u003cimg src=\"http://img.youtube.com/vi/XOc5kCE3MC0/maxresdefault.jpg\" alt=\"Robot Arduino firmware, ROS2/Docker PC setup instructions video\" width=\"720\" height=\"405\" border=\"10\" /\u003e\n\u003c/a\u003e\n\n### Download Latest Pre-Built Image\n- Docker Hub [image](https://hub.docker.com/r/kaiaai/kaiaai)\n  - Ubuntu `sudo docker pull kaiaai/kaiaai:iron`\n  - Windows command line `docker pull kaiaai/kaiaai:iron`\n\n### Run Kaia.ai (create a container)\n- on Windows\n  - open a command line window (or PowerShell or terminal)\n  - `cd` to `docker\\utils\\`\n  - launch container `.\\create_container_iron.cmd`\n  - open another command line window, `cd` to `docker\\utils\\`\n  - launch an extra bash session `.\\launch_bash.cmd`\n  - be sure to install \n- on Ubuntu\n  - open a bash window\n  - `cd` to `docker\\utils\\`\n  - launch container `source create_container_iron.sh`\n\n\n# Advanced - how to rebuild images\n\n## log in to Docker Hub\n```\nsudo docker login -u your_docker_hub_username\n```\n\n## Build image - Linux\n- install [Docker for Linux](https://docs.docker.com/engine/install/ubuntu/)\n- clone the Kaia.ai Docker repo and run the command below\n```\ngit clone https://github.com/kaiaai/install\ncd install/docker\nsource utils/build_iron.sh\n```\n\n## Build all images - Windows\n- install [Docker for Windows](https://docs.docker.com/desktop/install/windows-install/)\n- clone the Kaia.ai Docker repo and run the command below\n```\ngit clone https://github.com/kaiaai/install\ncd install\\docker\n.\\utils\\build_iron.cmd\n# .\\utils\\attest_iron.cmd\n```\n\n## Release history\n\n### 7/21/2025\n- added VNC server and Xfce, see https://github.com/makerspet/support/discussions/48\n\nWhen using VNC instead of X server, run kaiaai/kaiaai docker image as follows in Windows:\n```\ndocker run --name makerspet -it --rm -v c:\\maps:/root/maps -p 8888:8888/udp -p 4430:4430/tcp -p 5901:5901 -e DISPLAY=:1 kaiaai/kaiaai:iron\n```\n\nLaunch the VNC server inside the Docker container. You will be prompted to choose a VNC password.\n```\nvncserver :1 -geometry 1920x1080 -depth 24 -localhost no\n```\n\nInstall a VNC viewer, e.g. https://www.tightvnc.com/ on your Windows or MacOS PC.\n\nLaunch the VNC viewer. Open `localhost:5061` and enter your VNC password.\n\n### 3/10/2025\n- major bugfix: Delta, Delta-2G LiDARs decoding in kaiaai_telemetry package\n- matching [Kaia.ai firmware](https://github.com/kaiaai/firmware) release v0.8.3\n- image tag `kaiaai/kaiaai-031125:iron` https://hub.docker.com/repository/docker/kaiaai/kaiaai-031125\n\n### 3/9/2025\n- fixed LiDAR model names in `telem.yaml`\n- mapped `/root/maps` to host\n- added map save, map load and explore_lite to command history\n\n### 12/29/2024\n- dropping support for ROS2 `humble` because it is EOL\n  - switched builds to `iron`\n\n### 12/2/2024\n- fixed .bash_history\n\n### 11/21/2024\n- added .bash_history with common commands for convenience\n\n### 11/20/2024\n- 12V 200RPM N20 motors for Mini\n\n### 9/19/2024\n- build with attestation\n\n### 4/13/2024\n- `docker pull kaiaai/kaiaai:humble-04-13-2024`\n- `docker pull kaiaai/kaiaai:iron-04-13-2024`\n- fixed a webserver script crash\n\n### 3/27/2024\n- `docker pull kaiaai/kaiaai:humble-03-27-2024`\n- `docker pull kaiaai/kaiaai:iron-03-27-2024`\n- changed naming from `kaiaai-ros-dev` to `kaiaai`\n- added Camsense X1 LiDAR\n\n### 3/15/2024\n- changed default image name to kaiaai/kaiaai from kaiaai/kaiaai-ros-dev\n- merged Dockerfiles into a single one\n- added kaiaai_python package\n- paused building/releasing kaia-ros image\n  - use kaia-ros-dev instead of kaia-ros\n- merged kaiaai into kaiaai-ros-dev\n- kaiaai_cli single main branch\n\n### 2/11/2024\n- `docker pull kaiaai/kaiaai-ros-dev:humble-02-11-2024`\n- `docker pull kaiaai/kaiaai-ros-dev:iron-02-11-2024`\n- [ROS2 kaiaai_telemetry package](https://github.com/kaiaai/kaiaai)\n  - added support for 3irobotix Delta-2A, Delta-2G laser distance scan sensors\n\n### 2/5/2024\n- `docker pull kaiaai/kaiaai-ros-dev:humble-02-05-2024`\n- `docker pull kaiaai/kaiaai-ros-dev:iron-02-05-2024`\n- added LiDAR/LDS laser distance scan sensors support\n  - YDLIDAR X3, X3-PRO\n  - Neato XV11\n  - SLAMTEC RPLIDAR A1\n- split kaiaai_telemetry config into default and custom\n  - `kaiaai/kaiaai_telemetry/config/telem.yaml` is the default config\n  - `makerspet_loki/config/telem.yaml` is the custom config for the Loki robot model\n  - `makerspet_fido/config/telem.yaml` is the custom config for the Fido robot model\n  - `makerspet_snoopy/config/telem.yaml` is the custom config for the Snoopy robot model\n\n### 1/28/2024\n- `docker pull kaiaai/kaiaai-ros-dev:humble-01-28-2024`\n- `docker pull kaiaai/kaiaai-ros-dev:iron-01-28-2024`\n- added YDLIDAR X2 to kaiaai_telemetry\n- Arduino firmware moved to https://github.com/kaiaai/firmware\n\n### 1/21/2024\n- `docker pull kaiaai/kaiaai-ros-dev:humble-01-21-2024`\n- `docker pull kaiaai/kaiaai-ros-dev:iron-01-21-2024`\n- kaiaai_telemetry now supports multiple laser distance scan sensor models\n  - added Xiaomi 1st gen LDS02RR LDS; YDLIDAR X4 is default\n  - updated config/telem.yaml settings in makerspet_loki/fido/snoopy\n  - `ros2 launch kaiaai_bringup physical.launch.py robot_model:=makerspet_loki lds_model:=LDS02RR`\n  - `ros2 launch kaiaai_bringup physical.launch.py robot_model:=makerspet_loki lds_model:=YDLIDAR-X4`\n- Frontier exploration works, but needs debug\n  - `ros2 launch explore_lite explore.launch.py`\n\n### 12/11/2023\n- `docker pull kaiaai/kaiaai-ros-dev:humble-2023-12-11`\n- `docker pull kaiaai/kaiaai-ros-dev:iron-2023-12-11`\n- increased map saver timeout\n- Nav2 SLAM works in physical robot and in simulation\n  - `ros2 launch kaiaai_bringup navigation.launch.py robot_model:=makerspet_loki slam:=True`\n- kaiaai_teleop bugfix missing setup file\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaiaai%2Finstall","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaiaai%2Finstall","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaiaai%2Finstall/lists"}