zephyr/samples/subsys/mgmt/osdp
Siddharth Chandrasekaran ee99c34fb6 mgmt/osdp: Refactor struct osdp_cmd members for readability
Some of the names used in `struct osdp_cmd` where directly as in the
specification. Initially it appealed to keep them like that but with
time, a little more consistent naming of members helps if you haven't
read the specification document very recently.

Signed-off-by: Siddharth Chandrasekaran <siddharth@embedjournal.com>
2020-09-04 10:58:13 +02:00
..
src mgmt/osdp: Refactor struct osdp_cmd members for readability 2020-09-04 10:58:13 +02:00
CMakeLists.txt samples: mgmt/osdp: Add CP Sample 2020-09-04 10:58:13 +02:00
README.rst
prj.conf
sample.yaml samples: add missing sample.yaml files 2020-09-03 09:49:28 -04:00

README.rst

.. _osdp-sample:

OSDP
####

OSDP describes the communication interface one or more Peripheral Devices (PD)
to a Control Panel (CP). The specification describes the protocol
implementation over a two-wire RS-485 multi-drop serial communication channel.
Nevertheless, this protocol can be used to transfer secure byte stream over any
physical channel in low memory embedded devices.

Although OSDP is steered towards the Access and Security industries, it can be
used as a general communication protocol for devices in a secure way without
too much resource requirements. The security is not top-notch (AES-128) but it
is reasonable enough, given that the alternative is no security at all.

OSDP Supports the control of the following components on a PD:
   - LED
   - Buzzer
   - Keypad
   - Output (GPIOs)
   - Input Control (GPIOs)
   - Displays
   - Device status (tamper, power, etc.,)
   - Card Reader
   - Fingerprint Reader