dennisgunia/split-flap-controller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Dennis Gunia
2025-10-21 00:36:14 +02:00
parent e8f56806b6
commit 5d6337679f
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -23,16 +23,26 @@ __Ongoing Project! This repository is not final.__
- Integrated motor driver and position sensor handling - Integrated motor driver and position sensor handling
- Modules connect to a single backplane - Modules connect to a single backplane
- Hall-effect sensor homing - Hall-effect sensor homing
- Robust error handling
- detects homing faults, stuck drums, overcurrent and bus errors
- activates a failSafe condition on critical fault
- can be reset via RS485 in most conditions
- checks validity of each packet via checksum
### Firmware ### Firmware
- Lightweight communication protocol with checksum and addressing - Lightweight communication protocol with checksum and addressing
- Fault detection (homing failure, overcurrent, invalid position) - Fault detection (homing failure, overcurrent, invalid position)
- Persistent settings stored in EEPROM - Persistent settings stored in EEPROM
- CRC check of each message
### Software ### Software
- WebSocket-based control server - WebSocket-based control server
- Modular architecture for future GUI or API integrations - Modular architecture for future GUI or API integrations
- Easily portable to other platforms and MCUs - Easily portable to other platforms and MCUs
- Nginx Webserver allows you to controll the display with your smartphone
- very fast and written in plan c. I'm using libjson and libws for JSON handling and the WebSocket server
## CAD ## CAD
This display is designed in **Fusion360**. All schematics and boards are designed in **KiCAD 9**. This display is designed in **Fusion360**. All schematics and boards are designed in **KiCAD 9**.
@@ -49,6 +59,7 @@ This project is open source and available under the [AGPL-3.0 License](LICENSE).
- [SFBus Protocol](software/pc_client/doc/sfbus-proto.md) - [SFBus Protocol](software/pc_client/doc/sfbus-proto.md)
- [Websockets Protocol](software/pc_client/doc/api-doc.md) - [Websockets Protocol](software/pc_client/doc/api-doc.md)
- [BOM](cad/BOM_FlapUnit.md) - [BOM](cad/BOM_FlapUnit.md)
- Build guide wil follow soon!
## Power Consumption ## Power Consumption
Each Module pulls arround 110mA. This is roughly 1.4W of power. Each Module pulls arround 110mA. This is roughly 1.4W of power.