diff --git a/firmware/README.md b/firmware/README.md new file mode 100644 index 0000000..7682cc2 --- /dev/null +++ b/firmware/README.md @@ -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 ` | Set report mode | +| `pwm ` | Set PWM duty cycle to width / total | +