Skip to content

Commit

Permalink
updated readme for r4
Browse files Browse the repository at this point in the history
  • Loading branch information
Dustify committed Apr 13, 2021
1 parent ce1f37b commit b36ce09
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Screenshot

![POCSAG decoder](https://i.imgur.com/2iYM8Z7.png)
![POCSAG decoder](https://i.imgur.com/PsVOdEH.png)

# Installation

Expand All @@ -18,4 +18,21 @@ Provided the plugin has been loaded successfully, there should be an option to d

NFM with 12kHz bandwidth seems to work reliably, input is taken directly from the demodulator so audio filtering / mute shouldn't affect decoding.

![Plugin directory](https://i.imgur.com/9eGnJ9k.png)
![Plugin directory](https://i.imgur.com/9eGnJ9k.png)

## Options

### De-duplicate
The payload of each message is hashed (ignoring the first 9 characters, which seem to often include time data). With this option enabled new messages received with the same hash will be ignored.

### Hide bad decodes
Any messages that have failed BCH (CRC) or parity checks will be ignored.

### Clear
Will remove all messages from the buffer.

# Notes

* A maximum of 1000 messages will be displayed in the buffer, on a first-in-first-out basis.
* If a message payload is empty it is assumed to be tone message.
* If a message payload has fewer than 16 characters numerically, it is assumed to be a numeric message. In this case the numeric decode will be displayed first with the alphanumeric decode following e.g. "123456 (ALPHA: ABC)"

0 comments on commit b36ce09

Please sign in to comment.