C API Reference

The C API reference documents the public LibOSDP interface, exposed through a single header. It is grouped into the control panel and peripheral device entry points, the structures that describe a PD and carry commands and events, and the channel abstraction LibOSDP uses to talk to the bus. Use these pages as the contract when integrating the library into your application.

In this section ​

• Control Panel — LibOSDP control panel (CP) C API — set up an OSDP control panel, register peripheral devices, send commands, track completion, and handle events.
• Peripheral Device — LibOSDP peripheral device (PD) C API — implement an OSDP PD, advertise capabilities, respond to control panel commands, and report events.
• PD Info — LibOSDP pd_info_t reference — configure an OSDP device address, baud rate, capabilities, and secure channel keys when creating a CP or PD context.
• Miscellaneous — Miscellaneous LibOSDP C API helpers — logging, versioning, status, metrics, and file transfer utilities supporting OSDP control panel and peripheral device apps.
• Command Structure — LibOSDP command structure reference — the osdp_cmd data structures and enums used to send OSDP commands such as LED, buzzer, output, text, biometric, and key-set to a PD.
• Event Structure — LibOSDP event structure reference — the osdp_event data structures and enums a peripheral device uses to report card reads, key presses, biometrics, status, and notifications to the CP.
• Channel — LibOSDP channel abstraction — implement the send, receive, and flush callbacks that connect the OSDP library to your RS-485 or serial transport.