API Reference

The reference covers the K-FSW public headers in:

• kfsw-platform/include/kfsw/
• kfsw-services/include/kfsw/
• kfsw-comms/include/kfsw/
• kfsw-modules/radio-uhf/include/kfsw/
• kfsw-modules/boton-test/include/kfsw/
• kfsw-modules/temperature-sensor-example/include/kfsw/

Under API Reference, use API Groups to browse by component or Headers for declarations, types, arguments, and return values.

Platform API

• Time for monotonic time
• Storage for the LittleFS mount and capacity
• Reset for the reset cause
• K-FSW platform watchdog for the watchdog

Services API

• Boot for the boot and readiness markers
• Logging for logging and log levels
• Parameters for local and remote parameters and snapshots
• FTP for file transfer over CSP/RDP
• Command for local and remote commands
• Event record for the event record
• K-FSW health monitoring for health monitoring
• K-FSW firmware update for firmware update
• K-FSW lightweight firmware upload for FWU lite uploads
• File based operations for file based operations

Communications API

• CSP for CSP setup, interfaces, routes and ping
• UART / KISS for UART/KISS status and the peer test

Reusable module APIs

• kfsw/modules/radio_uhf.h: radio identity, expected serial settings, link status and encryption
• boton_test Module for the button, LEDs and parameters
• Temperature sensor example module for the temperature example

Scope

Private sources, upstream libraries and build output are not included.