OOK Editor - portapack-mayhem/mayhem-firmware GitHub Wiki

On-Off Keying Editor

image

Introduction

That application is a lightly enhanced version of the ROOK application by @sasaga.

It was first published in his blog, then it made it's way to our repository, and finally it got a bit of tuning, ending up like is is now.

The original author also made a nice presentation video, that you should also watch and like. See it here !

The application allows you to control and utilize On-Off Keying (OOK) modulation. OOK is a simple modulation technique where binary data is transmitted by turning a signal on (1) or off (0). The app provides an interface to easily configure for transmitting OOK signals, enabling you to interact with basic wireless communication systems such as remote controls, RFID devices, toys, or simple telemetry applications.

Functionality

The application has several cursors that will allow you to modify the signal before it is transmitted and to configure the PP for the transmission such as frequencies and gains. It also allows you to choose between two options to load the OOK signal at bit level, either by writing it manually or by loading the configuration from an .OOK configuration file.

Cursors:

The application has the following cursors:

  1. Frequency and gain selector, you can set the frequency and gain to configure the PP for sending transmission.

    frequency and gain

  2. SampleRate, Step, SymbolRate, Repeat, PauseSymbol

    image

    • Samplerate: Defines the sample rate of your signal analysis, this cursor takes values such as 250k, 1M, 2M, 5M , 10M ,20M
    • Step: step to be used for SymbolRate and PauseSymbol fields: 1, 10, 100
    • SymbolRate: The number of symbols per seconds
    • Repeat: Numerical courses that define the number of repetitions of the signal.
    • PauseSymbol: Pause between repetitions in usecs
    • Payload: It is a label that shows your defined payload for the OOK transmission.
    • Button Set: The Set button will open a modal window so that you can insert your payload from the PP keyboard.
    • Button Open File: This button will allow to load the OOKEditor settings from a configuration file in extension .OOK from the SD of the PP.
    • Save File: It will allow you to save your configurations in a file.
    • Text Info: display loaded/saved file name, status messages, errors
    • Waveform: It will display the waveform of your OOK signal.
    • Button Send: Starts OOK signal transmission

Structure of .OOK configuration files

If you decide to either create your own configuration files or load some into the OOKEDitor application of the PP, you must comply with the following structure:

  • The file must have the extension .OOK

  • It should be placed in a directory named "OOKFILES" at the root of the sdcard

  • Each parameter must be separated by a space.

  • The order of the data is as follows:

    Frequency SampleRate SymbolsRate Repeat PauseSymbol Payload

  • Here is an example:

27000000 1M 1076 4 100 01110111011101110101010101010101010101110111011101110101