Crate libosdp_sys

Source
Expand description

Auto generated (bindgen) wrapper for LibOSDP C API exposed from osdp.h here.

Structs§

  • __fsid_t
  • osdp_channel
    @brief User defined communication channel abstraction for OSDP devices. The methods for read/write/flush are expected to be non-blocking.
  • osdp_cmd
    @brief OSDP Command Structure. This is a wrapper for all individual OSDP commands.
  • osdp_cmd_buzzer
    @brief Sent from CP to control the behaviour of a buzzer in the PD.
  • osdp_cmd_comset
    @brief Sent in response to a COMSET command. Set communication parameters to PD. Must be stored in PD non-volatile memory.
  • osdp_cmd_file_tx
    @brief File transfer start command
  • osdp_cmd_keyset
    @brief This command transfers an encryption key from the CP to a PD.
  • osdp_cmd_led
    @brief Sent from CP to PD to control the behaviour of it’s on-board LEDs
  • osdp_cmd_led_params
    @brief LED params sub-structure. Part of LED command. See @ref osdp_cmd_led.
  • osdp_cmd_mfg
    @brief Manufacturer Specific Commands
  • osdp_cmd_output
    @brief Command sent from CP to Control digital output of PD.
  • osdp_cmd_text
    @brief Command to manipulate any display units that the PD supports.
  • osdp_event
    @brief OSDP Event structure.
  • osdp_event_cardread
    @brief OSDP event cardread
  • osdp_event_keypress
    @brief OSDP Event Keypad
  • osdp_event_mfgrep
    @brief OSDP Event Manufacturer Specific Command
  • osdp_event_notification
    @brief LibOSDP event notification
  • osdp_file_ops
    @brief OSDP File operations struct that needs to be filled by the CP/PD application and registered with LibOSDP using osdp_file_register_ops() before a file transfer command can be initiated.
  • osdp_pd_cap
    @brief PD capability structure. Each PD capability has a 3 byte representation.
  • osdp_pd_id
    @brief PD ID information advertised by the PD.
  • osdp_pd_info_t
    @brief OSDP PD Information. This struct is used to describe a PD to LibOSDP.
  • osdp_status_report
    @brief Status report structure. Used by OSDP_CMD_STATUS and OSDP_EVENT_STATUS. In case of command, it is used to send a query to the PD while in the case of events, the PD responds back with this structure.

Constants§

Functions§

  • osdp_cp_flush_commands⚠
    @brief Deletes all commands queued for a give PD
  • osdp_cp_get_capability⚠
    @brief Get capability associated to a function_code that the PD reports in response to osdp_CAP(0x62) command. Calling this method before the CP has had a the chance to get this information will return invalid/stale results.
  • osdp_cp_get_pd_id⚠
    @brief Get PD ID information as reported by the PD. Calling this method before the CP has had a the chance to get this information will return invalid/stale results.
  • osdp_cp_modify_flag⚠
    @brief Set or clear OSDP public flags
  • osdp_cp_refresh⚠
    @brief Periodic refresh method. Must be called by the application at least once every 50ms to meet OSDP timing requirements.
  • osdp_cp_send_command⚠
    @brief Generic command enqueue API.
  • osdp_cp_set_event_callback⚠
    @brief Set callback method for CP event notification. This callback is invoked when the CP receives an event from the PD.
  • osdp_cp_setup⚠
    @brief This method is used to setup a device in CP mode. Application must store the returned context pointer and pass it back to all OSDP functions intact.
  • osdp_cp_teardown⚠
    @brief Cleanup all osdp resources. The context pointer is no longer valid after this call.
  • osdp_file_register_ops⚠
    @brief Register a global file operations struct with OSDP. Both CP and PD modes should have done so already before CP can sending a OSDP_CMD_FILE_TX.
  • osdp_get_file_tx_status⚠
    @brief Query file transfer status if one is in progress. Calling this method when there is no file transfer progressing will return error.
  • osdp_get_sc_status_mask⚠
    @brief Get a bit mask of number of PD that are online and have an active secure channel currently.
  • osdp_get_source_info⚠
    @brief Get LibOSDP source identifier as a const char *. This string has info about the source tree from which this version of LibOSDP was built. Used in diagnostics.
  • osdp_get_status_mask⚠
    @brief Get a bit mask of number of PD that are online currently.
  • osdp_get_version⚠
    @brief Get LibOSDP version as a const char *. Used in diagnostics.
  • osdp_logger_init⚠
    @brief Configure OSDP Logging.
  • osdp_pd_flush_events⚠
    @brief Deletes all events from the PD’s event queue.
  • osdp_pd_notify_event⚠
    @brief API to notify PD events to CP. These events are sent to the CP as an alternate response to a POLL command.
  • osdp_pd_refresh⚠
    @brief Periodic refresh method. Must be called by the application at least once every 50ms to meet OSDP timing requirements.
  • osdp_pd_set_capabilities⚠
    @brief Set PD’s capabilities
  • osdp_pd_set_command_callback⚠
    @brief Set callback method for PD command notification. This callback is invoked when the PD receives a command from the CP.
  • osdp_pd_setup⚠
    @brief This method is used to setup a device in PD mode. Application must store the returned context pointer and pass it back to all OSDP functions intact.
  • osdp_pd_teardown⚠
    @brief Cleanup all osdp resources. The context pointer is no longer valid after this call.
  • osdp_set_log_callback⚠
    @brief A callback function that gets called when LibOSDP wants to emit a log line. All messages (of all log levels) are passed on to this callback without any log formatting. This API is for users who may already have a logger configured in their application.

Type Aliases§

Unions§