mirror of
https://github.com/scottbez1/smartknob.git
synced 2025-11-04 17:19:40 +08:00
- Firmware
- Refactor all code to use a log interface rather than `Serial` directly
- Moved platformio.ini to root, so you can load the entire repo in VS Code and still use platformio
- Reduced graphic buffer bit depth to 8 bits (short on RAM :( )
- Implemented threadsafe log interface in interface_task (using a queue for posting log message)
- Created serial protocol interface and 2 implementations - plaintext (default) and protobuf (selected by sending a NULL byte)
- Protobuf protocol is roughly the same architecture as Splitflap's:
- PacketSerial (cobs) framing with NULL delimiters
- CRC32 checksums for packets
- nanopb generated code for encoding/decoding (generated firmware code is checked in, since it should change less frequently and this reduces burden to build the project from scratch)
- Software
- Typescript example host-side code:
- smartknobjs-proto
- Autogenerated types/encoding/decoding protobuf code (using protobufjs)
- smartknobjs
- Helper library for interfacing the with smartknob via serial/protobuf. Implements basic outgoing queue (with retries and ACK checking) and message callback for responding to messages from the SmartKnob
- example
- Basic demo CLI app that uses smartknobjs to connect to the smartknob, send a haptic config, and print state changes and log messages to the console
29 lines
785 B
JSON
29 lines
785 B
JSON
{
|
|
"name": "example",
|
|
"version": "0.1.0",
|
|
"description": "SmartKnob Interface Library",
|
|
"main": "dist/index.js",
|
|
"types": "dist/index.d.ts",
|
|
"scripts": {
|
|
"build": "tsc",
|
|
"format": "prettier --write \"**/*.+(js|ts|json)\"",
|
|
"lint": "eslint --ext .js,.ts .",
|
|
"main": "ts-node src/index.ts"
|
|
},
|
|
"author": "",
|
|
"license": "Apache-2.0",
|
|
"dependencies": {
|
|
"serialport": "^9.2.4",
|
|
"smartknobjs": "^0.1.0"
|
|
},
|
|
"devDependencies": {
|
|
"@types/serialport": "^8.0.2",
|
|
"@typescript-eslint/eslint-plugin": "^5.40.1",
|
|
"@typescript-eslint/parser": "^5.40.1",
|
|
"eslint": "^8.25.0",
|
|
"prettier": "^2.4.1",
|
|
"ts-node": "^10.2.1",
|
|
"typescript": "^4.8.4"
|
|
}
|
|
}
|