Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
argilo committed Mar 4, 2024
1 parent cafd3db commit 6c4c01f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
secplus
=======

This project is a software implementation of the Security+ and Security+ 2.0 rolling code systems used in garage door openers made by Chamberlain, LiftMaster, Craftsman and others. Sample GNU Radio flowgraphs for receiving and transmitting codes are provided. A stand-alone Python module can be used to build other applications.
This project is a software implementation of the Security+ and Security+ 2.0 rolling code systems used in garage door openers made by Chamberlain, LiftMaster, Craftsman and others.

Encoding and decoding functionality is implemented in a MicroPython-compatible Python module (`secplus.py`) as well as an Arduino-compatible C library (`secplus.c` & `secplus.h`).

Sample GNU Radio flowgraphs for receiving and transmitting codes are also provided.

## Requirements

The following components are required to run the sample GNU Radio flowgraphs:

* GNU Radio 3.8 or later
* gr-osmosdr
* SDR hardware supported by gr-osmosdr (e.g. RTL-SDR, HackRF)
Expand Down Expand Up @@ -49,7 +55,7 @@ The rolling code should be at least 1 higher than the previously transmitted rol

### secplus.py

This Python module encodes and decodes the rolling and fixed codes, provides utility functions to prepare on-off keying sequences for transmission, and pretty-print the codes. It can be used to build stand-alone applications.
This Python module encodes and decodes the rolling and fixed codes, provides utility functions to prepare on-off keying sequences for transmission, and pretty-print the codes. It can be used to build stand-alone applications. It uses a limited subset of Python so that it can be executed in MicroPython.

### secplus.c & secplus.h

Expand Down

0 comments on commit 6c4c01f

Please sign in to comment.