Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fasteddy516 committed May 25, 2018
1 parent 0c1ceb5 commit 300eea7
Showing 1 changed file with 15 additions and 21 deletions.
36 changes: 15 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This plugin takes the dashboard status and/or player journal updates from Elite: Dangerous as ingested by EDMC and distributes them via the [MQTT connectivity protocol](http://mqtt.org/). The plugin is highly configurable, allowing individual status items to be enabled/disabled, as well as fully customizable MQTT topics.


## Prerequisites

In order to use this plugin, a correctly installed and configured MQTT broker is required. I personally use - and develop EDMC-Telemetry using - the [Eclipse Mosquitto™](https://mosquitto.org/) broker installed on a [Raspberry Pi](http://raspberrypi.org).
Expand Down Expand Up @@ -39,28 +39,22 @@
* **Topic**: MQTT topic to use for publishing dashboard status _(default=dashboard)_. This will be used in conjunction with the specified root topic, i.e. _telemetry/dashboard_.

* **Status**: Status elements to include when publish format is set to **processed**.
* Flags (check/topic)
* Pips (check/topic)
* FireGroup (check/topic)
* GuiFocus
* Latitude
* Longitude
* Heading
* Altitude
* Flag Format (combined. discrete)
* Pip Format (combined, discrete)
* Pip Topics
* Sys
* Eng
* Wep
* **Flags, Pips, FireGroup, GuiFocus, Latitude, Longitude, Heading, Altitude**: reporting for each of these dashboard status elements can be enabled/disabled using the associated checkbox, and a custom MQTT topic can be applied in the associated text-entry field.

* **Flag Format**: When set to **combined**, the single 32-bit combined flag value generated by E:D will be published using the specified flag topic. When set to **discrete**, each bit of the 32-bit flag value can be individually reported with an associated subtopic. _(See the 'Flags Tab' section below)_

* **Pip Format**: When set to *combined*, all three pip values are published as received in a single string. When *discrete* is selected, each pip value is reported under its own subtopic.

* **Pip Topics**: When the 'Pip Format' is set to *discrete*, these subtopics are used to publish the *Sys*, *Eng* and *Wep* pip settings.

* **Flags Tab**
* Tons! Each has check/topic
* When the 'Flag Format' on the 'Dashboard' tab is set to *discrete*, each individual bit that makes up the 32-bit combined mask value can be enabled/disabled as needed, and published using the specified subtopic.

* **Journal Tab**
* Publish Format (none, raw)
* Topic

* **Publish Format**: Determines how to publish journal messages. Select **none** to disable publishing of journal messages, or **raw** to publish journal entries as raw JSON.

* **Topic**: MQTT topic to use for publishing journal messages _(default=journal)_. This will be used in conjunction with the specified root topic, i.e. _telemetry/journal_.


## Comments and Suggestions

Expand All @@ -69,6 +63,6 @@

## License

Copyright © 2018 Edward Wright.
Copyright © 2018 Edward Wright.

Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-3.0.html) version 3.
Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-3.0.html) version 3.

0 comments on commit 300eea7

Please sign in to comment.