summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2020-10-15 14:06:56 +0200
committerxengineering <mail2xengineering@protonmail.com>2020-10-15 14:06:56 +0200
commit139bcb8821ba39e94d38d32f61210e4a2c1c75f0 (patch)
tree846208cfa481bfa7d269eb0a551be30bd22d4f7e /README.md
parent3f739baab456c2cc977f11090381d1f61eb023c4 (diff)
downloadiot-barcode-scanner-139bcb8821ba39e94d38d32f61210e4a2c1c75f0.tar
iot-barcode-scanner-139bcb8821ba39e94d38d32f61210e4a2c1c75f0.tar.zst
iot-barcode-scanner-139bcb8821ba39e94d38d32f61210e4a2c1c75f0.zip
Implement Makefile for Installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 96b137f..318331c 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,17 @@ A service that makes barcode scanners available on the network for IoT use.
## Usage
-1. Adapt config.json file if needed.
-2. Run ```sudo python barcode_scanner_daemon.py```
-3. Run ```python barcode_transmit_daemon.py```
-4. Listen to MQTT output (e.g. with ```mosquitto_sub -h localhost -t "xengineering.eu/iot-barcode-scanner"```)
+1. Installation
+ ```
+ sudo pip3 install paho-mqtt evdev
+ git clone https://github.com/xengineering/iot-barcode-scanner.git
+ cd iot-barcode-scanner
+ sudo make install
+ ```
+2. Configure /etc/xengineering.eu/iot_barcode_scanner/config.json
+3. Run ```sudo eu.xengineering.iot_barcode_scanner.scanner```
+4. Run ```eu.xengineering.iot_barcode_scanner.transmitter```
+5. Listen to MQTT output (e.g. with ```mosquitto_sub -h localhost -t "xengineering.eu/iot-barcode-scanner"```)
## Milestones
@@ -19,8 +26,8 @@ A service that makes barcode scanners available on the network for IoT use.
- [x] Use config file
- [x] Disable scanner as regular input source and bind it only to the service
- [x] Split into two executables to reduce root-priviledged code
+- [x] Write Makefile for easy installation
- [ ] Implement systemd services
-- [ ] Write Makefile for easy installation
- [ ] Implement auto discovery of barcode scanners
- [ ] Package it for Arch Linux