VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-12-25 04:03:30 -05:00
Code Issues Projects Releases Wiki Activity
460576e640
sdrangel/plugins/feature/gs232controller/readme.md

123 lines
5.6 KiB
Markdown
Raw Normal View History

GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h1>Rotator Controller Feature Plugin</h1>
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
<h2>Introduction</h2>
Update API
2021-11-23 07:28:06 -05:00
The Rotator Controller feature plugin allows SDRangel to send commands to GS-232 and SPID rotators as well as hamlib's rotctld, via a serial or TCP connection.
This allows SDRangel to point antennas mounted on a rotator to a specified azimuth and elevation.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
Map updates. Add support for different map types (street/satellite) and different map providers. Support finding real world addresses on the map. Add Maidenhead locator converter. Add Beacons. Allow data sources to be selected by a user. Add context menu to allow setting an object as a target, setting center frequency and adjusting display order.
2021-01-22 09:54:22 -05:00
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.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
<h2>Interface</h2>
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
![Rotator Controller feature plugin GUI](../../../doc/img/GS232Controller_plugin.png)
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
<h3>1: Start/Stop plugin</h3>
GS-232 Controller Updates Fix broken pipe #1006. Add onTarget and current and target aziumth and elevation to web report. Set run/stop button background to yellow when rotator is rotating (not onTarget). Use floating point value for tolerance setting.
2021-10-05 09:03:31 -04:00
This button starts or stops the plugin. When the plugin is stopped, azimuth and elevation commands will not be sent to the rotator.
When started, the background will be green if the rotator is pointing at target azimuth and elevation within the specified tolerance. When off target (i.e. while rotating) the background will be yellow.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
<h3>2: Azimuth</h3>
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
Specifies the target azimuth (angle in degrees, clockwise from North) to point the antenna towards. Valid values range from 0 to 450 degrees.
GS-232 Controller Updates Fix broken pipe #1006. Add onTarget and current and target aziumth and elevation to web report. Set run/stop button background to yellow when rotator is rotating (not onTarget). Use floating point value for tolerance setting.
2021-10-05 09:03:31 -04:00
The value to the right of the target azimuth, is the current azimuth read from the rotator.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
<h3>3: Elevation</h3>
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
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.
GS-232 Controller Updates Fix broken pipe #1006. Add onTarget and current and target aziumth and elevation to web report. Set run/stop button background to yellow when rotator is rotating (not onTarget). Use floating point value for tolerance setting.
2021-10-05 09:03:31 -04:00
The value to the right of the target elevation, is the current elevation read from the rotator.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
<h3>4: Track</h3>
When checked, the target azimuth and elevation will be controlled by the Channel or Feature Source (5).
Fix typing errors in readme's Fixed with: find . -name '*.md' -exec codespell --ignore-words-list=doas,ehr,lits,verry --write-changes --summary {} \+
2022-05-15 06:39:57 -04:00
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 setting Source to the Star Tracker plugin.
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
<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.
Add SPID rot2prog protocol support. Add tolerance setting.
2021-05-30 07:38:07 -04:00
<h3>7: Protocol</h3>
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
Selects which protocol to use. This can be GS-232, SPID (rot2prog) or rotctld.
Add SPID rot2prog protocol support. Add tolerance setting.
2021-05-30 07:38:07 -04:00
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>8: Connection</h3>
Add SPID rot2prog protocol support. Add tolerance setting.
2021-05-30 07:38:07 -04:00
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
Selects whether to use a serial connection or TCP.
Add SPID rot2prog protocol support. Add tolerance setting.
2021-05-30 07:38:07 -04:00
<h3>9: Serial Port</h3>
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller Updates Fix broken pipe #1006. Add onTarget and current and target aziumth and elevation to web report. Set run/stop button background to yellow when rotator is rotating (not onTarget). Use floating point value for tolerance setting.
2021-10-05 09:03:31 -04:00
Specifies the serial port (E.g. COM3 on Windows or /dev/ttyS0 on Linux) that will be used to send commands to the rotator.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
Add SPID rot2prog protocol support. Add tolerance setting.
2021-05-30 07:38:07 -04:00
<h3>10: Baud rate</h3>
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller Updates Fix broken pipe #1006. Add onTarget and current and target aziumth and elevation to web report. Set run/stop button background to yellow when rotator is rotating (not onTarget). Use floating point value for tolerance setting.
2021-10-05 09:03:31 -04:00
Specifies the baud rate that will be used to send commands to the rotator. Typically this is 9600 for GS-232.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>11: Host</h3>
Update API
2021-11-23 07:28:06 -05:00
Specifies the hostname / IP address of the computer to connect to.
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>12: Port</h3>
Update API
2021-11-23 07:28:06 -05:00
Specifies the TCP port number to connect to.
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>13: Azimuth Offset</h3>
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
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.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>14: Elevation Offset</h3>
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
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.
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>15 and 16: Azimuth Min and Max</h3>
Add min and max limits for azimuth and elevation in GS-232 controller. Add satellite tracker support
2021-02-26 15:27:35 -05:00
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.
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>17 and 18: Elevation Min and Max</h3>
Add min and max limits for azimuth and elevation in GS-232 controller. Add satellite tracker support
2021-02-26 15:27:35 -05:00
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.
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
<h3>19: Tolerance</h3>
Specifies a tolerance in degrees, below which, changes in target azimuth or elevation will not be sent to the rotator.
This can prevent some rotators that have a limited accuracy from making unbeneficial movements.
If this set to 0, every target azimuth and elevation received by the controller will be send to the rotator.
If it is set to 2, then a change in azimuth of +-1 degree from the previous azimuth, would not be sent to the rotator.
Update API
2021-11-23 07:28:06 -05:00
<h2>Protocol Implementations</h2>
<h3>GS-232 Protocol Implementation Notes</h3>
Add min and max limits for azimuth and elevation in GS-232 controller. Add satellite tracker support
2021-02-26 15:27:35 -05:00
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.
Update API
2021-11-23 07:28:06 -05:00
<h3>SPID rot2prog Protocol Implementation</h3>
Add SPID rot2prog protocol support. Add tolerance setting.
2021-05-30 07:38:07 -04:00
The controller uses the 0x2f set command with PH/PV=2 to set azimuth and elevation.
The 0x1f status command is used to read current azimuth and elevation.
A 12 byte response is expected for set and status commands.
All frames start with 0x57 and end with 0x20.
Update API
2021-11-23 07:28:06 -05:00
<h3>rotctld Protocol Implementation</h3>
GS232 Rotator Controller updates Add support for hamlib/rotctld protocol. Add support for TCP connections. Name plugin Rotator Controller, rather than GS-232 Rotator Controller, as it now supports 3 different protocols.
2021-11-23 07:13:24 -05:00
The controller uses the 'P' and 'p' commands to set and get azimuth and elevation.
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
<h2>API</h2>
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
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:
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
curl -X PATCH "http://127.0.0.1:8091/sdrangel/featureset/0/feature/0/settings" -d '{"featureType": "GS232Controller", "GS232ControllerSettings": { "azimuth": 180, "elevation": 45 }}'
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
To start sending commands to the rotator:
Add ADS-B Demodulator plugin. Add GS232 Rotator Controller feature plugin. Add altitude and station name to My Positon. Use QtDeploy to ensure all required Qt libraries are included (Should fix OpenGL issues)
2020-10-27 12:22:10 -04:00
GS-232 Controller updates. Update GS-232 controller to use message pipes for the target. Add field displaying the name of the target. Add azimuth and elevation offsets. Report worker thread errors to the GUI.
2021-01-13 14:44:53 -05:00
curl -X POST "http://127.0.0.1:8091/sdrangel/featureset/0/feature/0/run"
Reference in New Issue Copy Permalink