README: init

This commit is contained in:
Astro 2019-09-14 16:59:21 +02:00
parent 8163d083b9
commit 328f6921fa
1 changed files with 27 additions and 0 deletions

27
firmware/README.md Normal file
View File

@ -0,0 +1,27 @@
## Network
### Setup
Ethernet, IP: 192.168.1.26/24
Use telnet or netcat to connect to port 23/tcp (telnet)
### Reading ADC input
Set report mode to `once` to obtain the single next value. Report mode
will turn itself off after the next reading.
Set report mode to `continuous` for a continuous stream of input data.
The scope of this setting is per TCP session.
### Commands
| Syntax | Function |
| --- | --- |
| `report` | Report mode: once |
| `report mode` | Show current report mode |
| `report mode <off or once or continuous>` | Set report mode |
| `pwm <width> <total>` | Set PWM duty cycle to width / total |