Macintosh-HW
/
quack
mirror of https://github.com/demik/quack.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Documentation for main subfolder

This commit is contained in:
demik 2021-08-24 13:46:45 +02:00 committed by GitHub
parent f4bb8b1046
commit c1fd23186c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
main/README.md Normal file
View File

@ -0,0 +1,20 @@
# Quack Firmware source code
### Supported SDK versions:
The code is designed to be build with ESP-IDF SDK version 4.2.2. To workaround some patchs or limitations of this specific release, you need to apply the patch located in the SDK subfolder
### Unsupported mouse conversions:
Functions are grouped into "domains" in different files. Each functions has a prefix for its own domain.
For example, adb_init() is the init function for the ADB Bus and is located in the adb.c source file.
List of relevant files:
- adb.* Apple Desktop Bus related functions
- blue.* Bluetooth related functions
- esp_hid_gap.* HID GAP library from Espressif
- gpio.* raw GPIO related functions
- led.* LED related functions
- m4848.h Header for Apple Hockey Puck mouse over Bluetooth emulation
- main.c Everything start here
- quad.c Quadrature related functions (mouse port)