Giter Club home page Giter Club logo

rtl_433_tests's Introduction

rtl_433 test samples

rtl_433_tests contains the test suite for rtl_433

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

Running

Enter the directory and run make test. The output will tell if the tests failed or not.

Contributing

Run rtl_433 with rtl_433 -S unknown and wait for you signal to be detected. When it is detected note what gfile name it has. This file can now be run through rtl_433 offline:

$ rtl_433 -r g001.cu8

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.

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.

Browse the Decoder and Sample Explorer to see how we extract metadata from rtl_433_tests.

To discuss the device and decoding open an issue on rtl_433. 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.

rtl_433_tests's People

Contributors

zuckschwerdt avatar merbanan avatar vestom avatar enavarro222 avatar rct avatar pucebaboon avatar ovrheat avatar ludwich66 avatar keonen avatar iotzo avatar ionum avatar ygator avatar mhansen avatar pjkundert avatar fraschizzato avatar kissandr avatar johnjore avatar hkazu avatar mattrivett avatar storole avatar jonathanmbradshaw avatar curlyel avatar mcauser avatar maxlock avatar mnhauke avatar klohner avatar eusahues avatar untergasser avatar viraptor avatar tomq42 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.