[WIP] Core api (#134)
* add input debounce code from old fw * exampl of input api * change input API to get/release * revert input API to read * pointer instead of instance * add input API description * add display API * rewrite display names * migrate to valuemanager * add links * little changes * add LED API * add closing brakets * add sound api * change format * Delete input.c * Delete input.h * change format
This commit is contained in:
82
wiki/fw/Core-API.md
Normal file
82
wiki/fw/Core-API.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Basic concepts:
|
||||
|
||||
* ValueMutex
|
||||
* PubSub, Publisher, Subscriber
|
||||
* ValueManager
|
||||
* LayeredReducer
|
||||
|
||||
# HAL
|
||||
|
||||
We use [Zephyr HAL](https://docs.zephyrproject.org/latest/reference/peripherals/index.html).
|
||||
|
||||
# OS
|
||||
|
||||
We use [CMSIS OS v2](https://www.keil.com/pack/doc/CMSIS_Dev/RTOS2/html/group__CMSIS__RTOS.html) for thread management and IPC.
|
||||
|
||||
# UI
|
||||
|
||||
* **[Input](API:Input)**
|
||||
|
||||
* **[Display](API:Display)**
|
||||
|
||||
* **[LED](API:LED)**
|
||||
|
||||
## vibro
|
||||
|
||||
* **[Sound](API:Sound)**
|
||||
|
||||
## backlight
|
||||
|
||||
# System
|
||||
|
||||
## batt voltage
|
||||
|
||||
## batt charge
|
||||
|
||||
# CC1101
|
||||
|
||||
## SPI
|
||||
|
||||
## IRQ
|
||||
|
||||
# SD Card
|
||||
|
||||
## SPI
|
||||
|
||||
# NFC
|
||||
|
||||
## SPI
|
||||
|
||||
## IRQ
|
||||
|
||||
# IR
|
||||
|
||||
## TX LED
|
||||
|
||||
## RX ADC
|
||||
|
||||
# RFID 125 kHz
|
||||
|
||||
## Carrier
|
||||
|
||||
## Pull
|
||||
|
||||
## Comparator RX (shared with touch key)
|
||||
|
||||
# Touch key
|
||||
|
||||
## Pull
|
||||
|
||||
## Comparator RX (shared with RFID 125 kHz)
|
||||
|
||||
# External GPIO
|
||||
|
||||
# External SPI
|
||||
|
||||
# External I2C
|
||||
|
||||
# UART
|
||||
|
||||
# USB
|
||||
|
||||
# BLE
|
Reference in New Issue
Block a user