Skip to content

Latest commit

 

History

History
226 lines (204 loc) · 6.42 KB

README.md

File metadata and controls

226 lines (204 loc) · 6.42 KB

Resgrid Relay

Resgrid Relay is a desktop and CLI application for creating calls in the Resgrid system based on watchers (audio, file, database, etc).


Build status

About Resgrid

Resgrid is a software as a service (SaaS) logistics, management and communications platform for first responders, volunteer fire departments, career fire, EMS, Search and Rescue (SAR), public safety, HAZMAT, CERT, disaster response, etc.

Sign up for your free Resgrid Account Today!

System Requirements

  • Windows 7 or newer
  • .Net Framework 4.6.2
  • 1.8Ghz Single Core Processor
  • 8GB of RAM
  • 2GB of Free Disk Space
  • For Scanner audio a Scanner with an Audio Line Out i.e. WS1065 is needed

Configuration

// settings.json
{
  "InputDevice": 0,
  "AudioLength": 60,
  "ApiUrl": "https://api.resgrid.com",
  "Username": "TEST",
  "Password": "TEST",
  "Multiple": false,
  "Tolerance": 100,
  "Threshold": -40,
  "Watchers": [
    {
	  "Id": "ee188c37-09f4-47c0-9ff1-fe34c9d6a5f1",
      "Name": "Station 1",
      "Active": true,
      "Code": null,
      "Type": 0,
      "Eval": 0,
      "Triggers": [
        {
          "Frequency1": 524.0,
          "Frequency2": 794.0,
          "Time": 500,
          "Count": 2
        }
      ]
    },
	...
  ]
}

Settings

Settings.json Values

Setting Description
InputDevice The Audio Input device that system will listen to. It's recommend this is a hard Line In or Stereo Mix input and not a Mic input
AudioLength Time of time in SECONDS to record the dispatch audio for
ApiUrl The URL to talk to the Resgrid API (Services) for our hosted production system this is "https://api.resgrid.com"
Username Resgrid system login Username that can create calls
Password Resgrid system login Password for the Username above
Multiple Once a tone is Detected, do you want 1 call created and the Groups dispatched for it, or a call created in Resgrid for each watcher. If Multiple is false, one call will only be created and each Group (per watcher) will be dispatched as part of that call, if Multiple is true each watcher creates a call in Resgrid.
Tolerance The relative power of the tone frequency to trigger. This value should be between 50 and 250, ideally at or around 100 (the default). If your getting false triggers try increasing this value.
Threshold Decibel dB value for silence detection, default is -40. Depending on how loud the background audio or static is this value may need to be raised to cut out the static.
Debug Enable or Disable debug mode. Debug should only be enabled when trying to analyze an issue.
Watchers An Array of Watcher Objects

Watcher Settings Values

Setting Description
Id Unique GUID\UUID for the watcher, this value is used to queue and dequeue watchers and verify if one is already running. This value must be unique for every Watcher in the array.
Name Name of the group that this watcher is for. Seeming Watchers are tied to Resgrid groups it's usually best to just put the group name in here.
Active Can be true or false. Determines if this watcher is active and it's triggers should be monitored.
Code Your department groups dispatch code. For a Type of 2 (Group) You get this value from the Stations & Groups section of the website, and it's the alphanumeric code in front of @groups.resgrid.com. For a Type of 1 (Department) you get this from the Calls Import Settings screen excluding @dispatch.resgrid.com. Do not include anything other then the 6 character code.
Type 1 = Department, 2 = Group
Triggers Array of triggers

Triggers Settings Values

Setting Description
Frequency1 The first (or only) tone frequency to monitor
Frequency2 The second tone frequency to monitor
Time Time in milliseconds the tone need to run for to be triggered. If your tones run for 1 second (1000 milliseconds) each you should set this value to 750 or 500. If your getting false positives increase this value a bit. But tone length detection can be difficult if there is competing traffic or noise. So a lower value is 'safer'.
Count 1 or 2, the number of distinct tones your trigger has.

Installation

You should download the latest sable release from our Release page. It's recommend that you use the setup\installer based option.

Notes

Author's

License

Apache 2.0

Acknowledgments

Resgrid Relay makes use of the following OSS projects: