diff --git a/README.mkd b/README.mkd index 2b8d3ac..6b397fe 100644 --- a/README.mkd +++ b/README.mkd @@ -7,10 +7,11 @@ Python script for reading a line via UART and appending it to a CSV file along w ## What it does -This script is intended to be used as part of the device production process. -It collects a device's unique ID, displays it, stores it in a CSV file (along with a timestamp and the operator's name), and makes it available to a label printer. +The goal is to read a device's unique ID via UART, display it, log it in a CSV file (along with a timestamp and the operator's name), and print it via a label printer. This is a typical step of a device's production process. The unique ID is stuck on the device to help an installation technician know which device is which. -If the device would be a 1-Wire sensor, the device ID would be the sensor's unique 1-Wire bus address. +If the device is a 1-Wire sensor, the device ID would be the sensor's unique 1-Wire bus address. + +Test to work with Windows and Linux. ### Typical workflow 1. Get a device's unique ID via UART. @@ -30,6 +31,7 @@ If the device would be a 1-Wire sensor, the device ID would be the sensor's uniq ## Interaction with Arduino + * Default serial port configuration: 115200 8N1 (`serial_baud_rate`) * Default read timeout: 2 seconds (`serial_timeout_read`) * Default command to query Arduino for device: `print_id` (`serial_cmd`) @@ -37,14 +39,16 @@ If the device would be a 1-Wire sensor, the device ID would be the sensor's uniq ## Milestones -* [X] Basic user interaction + +* [X] Straightforward user interaction * [X] Write CSV file * [X] Working serial communication -* [ ] Print the device ID on a label printer +* [ ] Print the device ID via a label printer * [ ] Take care of the `TODO` and `FIXME` code annotations ## Getting started + It requires Python v2.7 or later. **Linux** @@ -149,5 +153,6 @@ See [LICENSE](LICENSE) for details. ## Comparable projects + **Please add them**