Skip to content

Commit fe7403f

Browse files
Dmitriy NogayGirgitt
Dmitriy Nogay
authored andcommitted
Typo fixes
Task list reformating and headings fixes.
1 parent c4a19a5 commit fe7403f

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

README.md

+27-23
Original file line numberDiff line numberDiff line change
@@ -16,45 +16,49 @@ PJON-python module opens popular uC platforms (Arduino, ESP8266, Teensy) to the
1616
- open-hardware IoT (thanks to integration flexibility of other python modules)
1717

1818

19-
##Current status:
19+
## Current status:
2020
- work in progress, minimal client operational with PJON v4.2 or v4.3 (ThroughHardwareSerial strategy is required)
2121
- initially PHY abstraction to BitBang and OverSampling strategies provided by a serial-PJON bridge implemented as Arduino sketch
2222
- support for ThroughHardwareSerial strategy in HALF_DUPLEX, multi-master communication mode e.g. over RS485 bus is provided directly (serial-RS485 converter required)
2323
- support for ThroughHardwareSerial strategy in SIMPLEX communication mode will be provided directly (e.g. to talk to a single Arduino).
2424
- Communication with a single arduino connected to USB works in HALF_DUPLEX mode out of the box without any additional hardware
2525

26-
##outstading features
27-
- PJON serial strategy
28-
- receive without ACK from local bus [done]
29-
- receive with ACK [done]
30-
- send without ACK to local bus [done]
31-
- send with ACK [done]
32-
- PJON protocol
33-
- receive [done]
34-
- send [done]
35-
- update [done]
36-
- repetitive send
37-
- local bus support [done]
38-
- including sender ID [done]
39-
- shared bus support
40-
- auto addressing (PJON v5 feature)
41-
- public api
42-
- blocking [implementing]
43-
- non-blocking [done]
44-
- auto-discover of serial-PJON bridge
26+
## Outstading features
27+
28+
- **PJON serial strategy**
29+
- [x] receive without ACK from local bus
30+
- [x] receive with ACK
31+
- [x] send without ACK to local bus
32+
- [x] send with ACK
33+
34+
- **PJON protocol**
35+
- [x] receive
36+
- [x] send
37+
- [x] update
38+
- [ ] repetitive send
39+
- [x] local bus support
40+
- [x] including sender ID
41+
- [ ] shared bus support
42+
- [ ] auto addressing (PJON v5 feature)
43+
44+
- **Public API**
45+
- [ ] blocking [implementing]
46+
- [x] non-blocking
47+
48+
- Auto-discover of serial-PJON bridge
4549

4650
PJON-python versions are aligned with PJON versions to indicate compatibility with C implementation for uC platforms.
4751

48-
####v4 goals:
52+
#### v4 goals:
4953
- local and remote serial port support with auto-discovery of the serial2pjon proxy arduino
5054
- PJON serial strategy for local bus with ACK support [done]
5155
- full PJON serial protocol for serial strategy (remote buses support)
5256

53-
####v5 goals:
57+
#### v5 goals:
5458
- auto addressing
5559

5660

57-
minimal client example
61+
## Minimal client example
5862
```python
5963
from pjon_python.base_client import PjonBaseSerialClient
6064
import time

0 commit comments

Comments
 (0)