Skip to content

Commit 6c4c01f

Browse files
committed
Update readme
1 parent cafd3db commit 6c4c01f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
secplus
22
=======
33

4-
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.
4+
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.
5+
6+
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`).
7+
8+
Sample GNU Radio flowgraphs for receiving and transmitting codes are also provided.
59

610
## Requirements
711

12+
The following components are required to run the sample GNU Radio flowgraphs:
13+
814
* GNU Radio 3.8 or later
915
* gr-osmosdr
1016
* SDR hardware supported by gr-osmosdr (e.g. RTL-SDR, HackRF)
@@ -49,7 +55,7 @@ The rolling code should be at least 1 higher than the previously transmitted rol
4955

5056
### secplus.py
5157

52-
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.
58+
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.
5359

5460
### secplus.c & secplus.h
5561

0 commit comments

Comments
 (0)