roomba-iot – Blame information for rev 2
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
2 | office | 1 | -:[ About ]: - |
2 | |||
3 | Roomba-IoT is automation software designed by Wizardry and Steamworks and meant |
||
4 | to work within an iRobot Roomba 5xx through 7xx that has been modified to |
||
5 | include an SBC (such as the Raspberry Pi Zero) interfaced with the Roomba's |
||
6 | serial port pins. |
||
7 | |||
8 | Compared to other projects, Roomba-IoT is neither a library nor an interactive |
||
9 | application but is rather meant to function as a system daemon that is handled |
||
10 | by publishing commands and sending sensor data to an MQTT bus. |
||
11 | |||
12 | -:[ Features ]:- |
||
13 | |||
14 | So far, Roomba-IoT implements the following features: |
||
15 | |||
16 | * Sending commands to the Roomba via MQTT. |
||
17 | * Reading all Roomba sensors and publishing them to the configurd MQTT bus. |
||
18 | |||
19 | -:[ Necessary Hardware Modifications ]:- |
||
20 | |||
21 | Roomba-IoT requires the Roomba to be opened and modified to embed an SBC. |
||
22 | More information on the hardware modification process can be found on the |
||
23 | project page at: |
||
24 | |||
25 | * http://grimore.org/roomba/embedded_computer_for_serial_interfacing |
||
26 | |||
27 | -:[ Usage ]:- |
||
28 | |||
29 | Download the release or development version of Roomba-Iot and then change |
||
30 | directory into the provided folder and issue: |
||
31 | |||
32 | npm install |
||
33 | |||
34 | to install all required packages. |
||
35 | |||
36 | Next, copy the file "config.yml.default" to "config.yml" and open the file in |
||
37 | a text editor to set the configuration parameters. |
||
38 | |||
39 | Finally, run Roomba-IoT on the console by issuing: |
||
40 | |||
41 | node main.js |
||
42 | |||
43 | To make Roomba-IoT run as a background daemon, copy the provided systemd file |
||
44 | "roomba-iot.service" from the "contrib" directory into /etc/systemd/system and |
||
45 | issue the following command: |
||
46 | |||
47 | systemctl enable roomba-iot |
||
48 | |||
49 | To start the service, issue: |
||
50 | |||
51 | systemctl start roomba-iot |
||
52 | |||
53 | conversely: |
||
54 | |||
55 | systemctl stop roomba-iot |
||
56 | |||
57 | to stop the Roomba-Iot daemon. |
||
58 | |||
59 | -:[ Contact and Support ]:- |
||
60 | |||
61 | * Email: office@grimore.org |
||
62 | * Project website: |
||
63 | |||
64 | http://grimore.org/roomba/embedded_computer_for_serial_interfacing |
||
65 | |||
66 |