mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-11-15 12:51:49 -05:00
83 lines
4.1 KiB
Markdown
83 lines
4.1 KiB
Markdown
<h1>GS-232 Rotator Controller Feature Plugin</h1>
|
|
|
|
<h2>Introduction</h2>
|
|
|
|
The GS-232 Rotator Controller feature plugin allows SDRangel to send commands to GS-232 rotators. This allows SDRangel to point antennas mounted on a rotator to a specified azimuth and elevation.
|
|
|
|
Azimuth and elevation can be set manually by a user in the GUI, via the REST API, or via another plugin, such as the Map Feature, the ADS-B Demodulator, or the Star Tracker.
|
|
|
|
<h2>Interface</h2>
|
|
|
|
![GS232 Rotator Controller feature plugin GUI](../../../doc/img/GS232Controller_plugin.png)
|
|
|
|
<h3>1: Start/Stop plugin</h3>
|
|
|
|
This button starts or stops the plugin. When the plugin is stopped, azimuth and elevation commands will not be sent to the GS-232 rotator.
|
|
|
|
<h3>2: Azimuth</h3>
|
|
|
|
Specifies the target azimuth (angle in degrees, clockwise from North) to point the antenna towards. Valid values range from 0 to 450 degrees.
|
|
The value to the right of the target azimuth, is the current azimuth read from the GS-232 rotator.
|
|
|
|
<h3>3: Elevation</h3>
|
|
|
|
Specifies the target elevation (angle in degrees) to point the antenna towards. Valid values range from 0 to 180 degrees, where 0 and 180 point towards the horizon and 90 degrees to zenith.
|
|
The value to the right of the target elevation, is the current elevation read from the GS-232 rotator.
|
|
|
|
<h3>4: Track</h3>
|
|
|
|
When checked, the target azimuth and elevation will be controlled by the Channel or Feature Source (5).
|
|
For example, this allows an aircraft to be tracked, by setting the Source to the ADS-B Demodulator plugin, or the Moon to be tracked by settng Source to the Star Tracker plugin.
|
|
|
|
<h3>5: Source</h3>
|
|
|
|
Specify the SDRangel Channel or Feature that that will control the target aziumth and elevation values, when Track (4) is checked.
|
|
|
|
<h3>6: Target</h3>
|
|
|
|
When tracking is enabled, this field will display a name for the target being tracked, as indicated by the selected Source plugin (5).
|
|
For example, the ADS-B plugin will display the flight number of the target aircraft. The Star Tracker plugin will display Sun, Moon or Star.
|
|
|
|
<h3>7: Serial Port</h3>
|
|
|
|
Specifies the serial port (E.g. COM3 on Windows or /dev/ttyS0 on Linux) that will be used to send commands to the GS-232 rotator.
|
|
|
|
<h3>8: Baud rate</h3>
|
|
|
|
Specifies the baud rate that will be used to send commands to the GS-232 rotator. Typically this is 9600.
|
|
|
|
<h3>9: Azimuth Offset</h3>
|
|
|
|
The azimuth offset specifies an angle in degrees that is added to the target azimuth before sending to the controller. This allows for a misalignment of the rotator to be corrected.
|
|
|
|
<h3>10: Elevation Offset</h3>
|
|
|
|
The elevation offset specifies an angle in degrees that is added to the target elevation before sending to the controller. This allows for a misalignment of the rotator to be corrected.
|
|
|
|
<h3>11 and 12: Azimuth Min and Max</h3>
|
|
|
|
The azimuth min and max values specify the minimum and maximum azimuth values (after offset has been applied), that will be sent to the rotator.
|
|
These values can be used to prevent the rotator from rotating an antenna in to an obstable.
|
|
|
|
<h3>13 and 14: Elevation Min and Max</h3>
|
|
|
|
The elevation min and max values specify the minimum and maximum elevation values (after offset has been applied), that will be sent to the rotator.
|
|
These values can be used to prevent the rotator from rotating an antenna in to an obstable.
|
|
If the maximum elevation is set to 0, the controller will only use the M GS-232 command, rather than M and W.
|
|
|
|
<h2>GS-232 Protocol Implementation</h2>
|
|
|
|
The controller uses the Waaa eee command when elevation needs to be set.
|
|
When only azimuth needs to be set, the Maaa command is used.
|
|
The C2 command is used to read current azimuth and elevation. A response of AZ=aaaEL=eee is expected.
|
|
|
|
<h2>API</h2>
|
|
|
|
Full details of the API can be found in the Swagger documentation. Here is a quick example of how to set the azimuth and elevation from the command line:
|
|
|
|
curl -X PATCH "http://127.0.0.1:8091/sdrangel/featureset/0/feature/0/settings" -d '{"featureType": "GS232Controller", "GS232ControllerSettings": { "azimuth": 180, "elevation": 45 }}'
|
|
|
|
To start sending commands to the rotator:
|
|
|
|
curl -X POST "http://127.0.0.1:8091/sdrangel/featureset/0/feature/0/run"
|