https://github.com/smartrent/jeff

An Elixir implementation of the Open Supervised Device Protocol (OSDP)
https://github.com/smartrent/jeff

osdp

Last synced: about 1 month ago
JSON representation

An Elixir implementation of the Open Supervised Device Protocol (OSDP)

• Host: GitHub
• URL: https://github.com/smartrent/jeff
• Owner: smartrent
• License: apache-2.0
• Created: 2021-08-05T04:03:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-08T16:44:52.000Z (over 1 year ago)
• Last Synced: 2024-08-11T10:50:01.110Z (5 months ago)
• Topics: osdp
• Language: Elixir
• Homepage:
• Size: 145 KB
• Stars: 10
• Watchers: 10
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


An Elixir implementation of the Open Supervised Device Protocol (OSDP).

[Open Supervised Device Protocol](https://www.securityindustry.org/industry-standards/open-supervised-device-protocol)

(OSDP) is an access control communications standard developed by the Security

Industry Association (SIA).

The OSDP standard describes the communication interface of one or more

Peripheral Devices (PD) to an Access Control Unit (ACU). The specification

describes the protocol implementation over a two-wire RS-485 multi-drop

serial communication channel.

OSDP Supports the control of components on a PD such as:

- LED

- Buzzer

- Keypad

- Output (GPIOs)

- Input Control (GPIOs)

- Displays

- Device status (tamper, power, etc.)

- Card Reader

- Fingerprint Reader

## Example

```elixir

{:ok, acu} = Jeff.start_acu(serial_port: "/dev/ttyUSB0")

Jeff.add_pd(acu, 0x7F, check_scheme: :crc)

Jeff.id_report(acu, 0x7F)

```

## License

Copyright (C) 2022 SmartRent

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.