Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zuckschwerdt committed Feb 24, 2020
1 parent 19f8230 commit 99ef85f
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ This repository contains lots of signal recordings that are supported by rtl_433

The regtest system is not developed yet, but accepting signal recordings.


## Installation instructions

Clone this reposity to the root of rtl_433
Expand All @@ -22,10 +21,28 @@ note what gfile name it has. This file can now be run through rtl_433 offline:

$ rtl_433 -r g001.cu8

You can also add `-a` or `-A` to see what it looks like in analyze mode.
Look at the `-A` analyze mode output and include a timing description if you like.
You can also include a flex decoder (`-X ...`), don't include raw analyzer output.

## Organization

Add signals by creating directories and then add the sample files.
We need to watch the repo size, add only about 5 interesting sample files.
If you have more interesting samples (e.g. to recover a checksum), include the bitbuffer codes in the `README.md`.

You can rename the sample files to add information, e.g. replace `g001` with `low_battery`. Do not remove the frequency and sample rate information.

Also add a `README.md` and perhaps pictures of the hardware. E.g. `front.jpg`, `back.jpg`, `inside.jpg`.
Limit the picture size to about 50k by cropping and compression.

Add signals by creating a directory with the protocol name and then add the gfiles under a
directory with 2 digit directory name. Also add a `readme.md` and a picture of the hardware. E.g.
Samples are contained in directories with the scheme: `tests/GROUP/DEVICE/SET`
- `GROUP` is optional and usually the manufacturer or common protocol, e.g. `lacrosse`
- `DEVICE` is the device name, e.g. `tx141w`
- `SET` is optional and used for different actual devices, not functions. E.g. `01`
- Each level should have a `README.md` describing that level.

tests/prologue/01
Browse the [Decoder and Sample Explorer](https://triq.org/explorer/) to see how we extract metadata from rtl_433_tests.

To discuss the device and decoding open an issue on [rtl_433](https://github.com/merbanan/rtl_433/issues).
Issues in rtl_433_tests are used for the acutal building and testing only.
PRs on rtl_433_tests should only discuss the merging and not the device.

0 comments on commit 99ef85f

Please sign in to comment.