113 lines
3.3 KiB
HTML
Executable File
113 lines
3.3 KiB
HTML
Executable File
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title></title></head><body><h1>Nmea/ComMaster TAB Plugin Description</h1>
|
|
|
|
<pre><code>Always use EqNumber 1 to guarantee that the telegram is used for ComMaster
|
|
</code></pre>
|
|
|
|
<p>This TAB Plugin manages the whole communication between ComMaster/RadioMaster Backpack and Excon.
|
|
The plugin use a Udp Socket to read and write data.</p>
|
|
|
|
<ol>
|
|
<li>General Description for Telegrams for direction</li>
|
|
<li>More detailed description for each Telegram</li>
|
|
<li>Which telegrams should be send in which order</li>
|
|
</ol>
|
|
|
|
<h2>1. General Description for Telegrams for direction</h2>
|
|
|
|
<h3>Excon to Nmea/ComMaster</h3>
|
|
|
|
<ul>
|
|
<li>SetPowerDeviceRequest</li>
|
|
</ul>
|
|
|
|
<h3>Nmea/ComMaster to Excon</h3>
|
|
|
|
<ul>
|
|
<li>PositionReport</li>
|
|
<li>BatteryInfo</li>
|
|
<li>BatteryAlarm</li>
|
|
<li>ServiceControl</li>
|
|
</ul>
|
|
|
|
<h2>2. More detailed description for each telegram</h2>
|
|
|
|
<h3>SetPowerDeviceRequest Telegram</h3>
|
|
|
|
<p>The telegram need to be send with <strong>Equipment Number 1</strong>.
|
|
The <strong>PowerMethod</strong> need to be <strong>PowerOff</strong>.
|
|
The ComMaster will immediately shut down after the command was send.
|
|
<strong>Structur SetPowerDeviceRequest:</strong></p>
|
|
|
|
<blockquote>
|
|
<p>Header<br>
|
|
- EqNumber : <em>Integer</em><br>
|
|
- Timestamp : <em>MsecsSinceEpoch</em><br>
|
|
powerType : <em>Enum</em> | Unknown = 0, PowerOn = 1, PowerOff = 2, <strong>Need to be PowerOff for ComMaster</strong><br>
|
|
subdeviceId : <em>Integer</em> | Not necessary for ComMaster<br></p>
|
|
</blockquote>
|
|
|
|
<h3>Position Report</h3>
|
|
|
|
<p>Under construction…</p>
|
|
|
|
<h3>BatteryInfo Telegram</h3>
|
|
|
|
<p>The telegram hold the informnation for each battery.<br>
|
|
<strong>Structure BatteryInfo:</strong></p>
|
|
|
|
<blockquote>
|
|
<p>Header<br>
|
|
- EqNumber : <em>Integer</em><br>
|
|
- Timestamp : <em>MsecsSinceEpoch</em><br>
|
|
Vector of BatteryStates</p>
|
|
</blockquote>
|
|
|
|
<p><strong>Structure BatteryState:</strong></p>
|
|
|
|
<blockquote>
|
|
<p>batteryPort : <em>Integer</em> | Right or left battery slot in Backup<br>
|
|
battery : <em>Integer</em> | State of charge 0-5, 0 = Empty , 5 = Full <br>
|
|
voltage : <em>Integer</em> | Maybe in mV <br>
|
|
temperature : <em>Integer</em> | In °C<br>
|
|
frequency : <em>Integer</em><br>
|
|
generic : <em>Integer</em><br>
|
|
current : <em>Integer</em><br>
|
|
switchOrValue : <em>Boolean</em><br>
|
|
serialNumber : <em>String</em><br></p>
|
|
</blockquote>
|
|
|
|
<h3>BatteryAlarm Telegram</h3>
|
|
|
|
<p><strong>Structure of BatteryAlarm:</strong></p>
|
|
|
|
<blockquote>
|
|
<p>Header<br>
|
|
- EqNumber : <em>Integer</em><br>
|
|
- Timestamp : <em>MsecsSinceEpoch</em><br>
|
|
id : <em>Integer</em><br>
|
|
description : <em>String</em><br>
|
|
acknowledge : <em>Boolean</em><br>
|
|
condition : <em>Boolean</em><br>
|
|
uniqueAlarmNumber : <em>Integer</em><br>
|
|
alarmTime : <em>Uint64</em><br></p>
|
|
</blockquote>
|
|
|
|
<h3>ServiceControl Telegram</h3>
|
|
|
|
<p>Hold the current power state of the ComMaster Backpack</p>
|
|
|
|
<p><strong>Structure of ServiceControl:</strong></p>
|
|
|
|
<blockquote>
|
|
<p>Header<br>
|
|
- EqNumber : <em>Integer</em><br>
|
|
- Timestamp : <em>MsecsSinceEpoch</em><br>
|
|
serviceControlState : <em>ServiceControlEnum</em> | 0 = PRESHUTDOWN (Device will prepare shutdown), 1 = SHUTDOWN (The devive will shutdown now), 2 = STOP (The device is off now)</p>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
|
|
<p>Author: Niklas Schmidt</p>
|
|
|
|
<p>Last Update: 05.06.22</p>
|
|
</body></html> |