Skip to content

Commit aa8980d

Browse files
Filipgitbook-bot
authored andcommitted
GITBOOK-32: No subject
1 parent 2323442 commit aa8980d

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/controller/os.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# OS
22

3+
## Description
4+
5+
Robopipe OS is a custom pre-configured OS image based on [Debian](https://www.debian.org/). It comes with all the packages and tools you need to build a AI/CV application pre-installed. You can find all releases along with the configuration scripts in [this repository](https://github.com/Robopipe/OS).
6+
7+
## Default configuration
8+
9+
### Users
10+
11+
The default user you should use when working on the controller directly is `admin`. The password is `robopipe.io`.
12+
13+
### Hostname & mDNS
14+
15+
A hostname is assigned to the controller on startup. The assigned hostname is in the format `robopipe-<id>`, where _id_ is determined dynamically on each startup. When the controller is started it will scan the local network, and assign itself the lowest possible _id_ which is not already taken. This means that the first controller you start will have _id_ 1, the next will have _id_ 2 and so on. At the same time, it will also broadcast an [mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) record based on its hostname (`robopipe-<id>.local`). This means that the controller can be addresses not only by its IP address, but also by its hostname in the local network. This behaviour is enabled via `robopipehostname` service, if you wish to disable it, you can do so using:
16+
17+
```bash
18+
sudo systemctl disable robopipehostname # this will take effect on the next startup
19+
```
20+
21+
### SSH
22+
23+
SSH server is running on the controller by default on port 22.
24+
25+
### Robopipe API
26+
27+
Robopipe API is configured to start automatically at startup. If you wish to disable this, you can do so using:
28+
29+
```bash
30+
sudo systemctl disable robopipeapi
31+
```
32+
33+
## Service Mode
34+
35+
Sevice mode is used for backing up the operating system, uploading new OS images or restoring access to the unit. This mode does not publish an mDNS record.
36+
37+
### Entering the Service Mode
38+
39+
* Turn off the controller
40+
* Press and hold the _SERVICE_ button on your controller (usually located next to USB labels)
41+
* Turn on the controller while still hodling the _SERVICE_ button
42+
* Release the _SERVICE_ button when all the LEDs start blinking periodically
43+

0 commit comments

Comments
 (0)