VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-16 05:11:49 -05:00
Code Issues Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
f4exb 2017-12-13 21:32:12 +01:00
parent 0436848490
commit 8798b64471
2 changed files with 121 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Readme.md
View File

@ -103,9 +103,7 @@ HackRF is better used with a sampling rate of 4.8 MS/s and above. The 2.4 and 3.
<h2>LimeSDR</h2> <h2>LimeSDR</h2>
<p><b>&#9888; LimeSuite library is difficult to implement due to the lack of documentation. The plugins should work normally when running as single instances. Support of many Rx and/or Tx instances running concurrently is considered experimental.</b></b> <p><b>&#9888; The plugins should work normally when running as single instances. Support of many Rx and/or Tx instances running concurrently is considered experimental.</b></b>
<p>&#9888; In particular it appears that due to the oddities of LimeSuite you cannot start the second stream alone or first. Starting just stream 0 will work and starting stream 0 then stream 1 will work also but neither starting stream 1 alone nor starting stream 1 before stream 0 will work. It actually produces a segfault in LimeSuite software and SDRangel will crash (issue #101 reported).</p>
You will need a minimal installation of LimeSuite. Presently version 17.12.1 should be used with its corresponding firmware (v4) and gateware (v2.12) installed in the LimeSDR device: You will need a minimal installation of LimeSuite. Presently version 17.12.1 should be used with its corresponding firmware (v4) and gateware (v2.12) installed in the LimeSDR device:

120
swagger/sdrangel/examples/Readme.md Normal file
View File

@ -0,0 +1,120 @@
## Examples of client scripts ##
<h2>add_channel.py</h2>
Adds a channel to a device set specifying device set index and channel type.
- Operation ID: `devicesetChannelPost`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/channel`
- HTTP method: `POST`
<h2>devicesets_config.py</h2>
Example of building an entire configuration with 3 device sets using presets to configure each one of the device sets then start streaming on all of them.
It uses the following APIs:
- To select a device in a device set:
- Operation ID: `devicesetDevicePut`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device`
- HTTP method: `PUT`
- To load a preset in a device set:
- Operation ID: `instancePresetPatch`
- URI: `/sdrangel/preset`
- HTTP method: `PATCH`
- To create a new device set:
- OperationID: `instanceDeviceSetsPost`
- URI: `/sdrangel/devicesets`
- HTTP method: `POST`
- Activate the DV serial dongle support for digital voice modes
- OperationID: `instanceDVSerialPatch`
- URI: `/sdrangel/dvserial`
- HTTP method: `PATCH`
- Start a device streaming
- OperationID: `devicesetDeviceRunPost`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/run`
- HTTP method: `POST`
<h2>nfm_test.py</h2>
Example of creating NFM channels (demodulator and modulator) and changing the settings
It uses the following APIs:
- To create a new channel:
- Operation ID: `devicesetChannelPost`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/channel`
- HTTP method: `POST`
- To create a new device set:
- OperationID: `instanceDeviceSetsPost`
- URI: `/sdrangel/devicesets`
- HTTP method: `POST`
- To change the settings of a channel:
- OperationID: `devicesetChannelSettingsPatch`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings`
- HTTP method: `PATCH`
<h2>ptt.py</h2>
Implements a basic push to talk (PTT) feature. Verifies that devise set #0 is a Rx and that #1 is a Tx. Stops streaming on one device and start streaming on the other depending on the PTT move (Rx to Tx or Tx to Rx).
It uses the following APIs:
- Get information on device sets:
- Operation ID: `instanceDeviceSetsGet`
- URI: `/sdrangel/devicesets`
- HTTP method: `GET`
- Start a device streaming
- OperationID: `devicesetDeviceRunPost`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/run`
- HTTP method: `POST`
- Stop a device streaming
- OperationID: `devicesetDeviceRunDelete`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/run`
- HTTP method: `DELETE`
<h2>rtlsdr_settings.py</h2>
Make sure a RTLSDR device is selected on device set #0. Get and change the settings of this RTLSDR device.
It uses the following APIs:
- Get information on a device set:
- Operation ID: `devicesetGet`
- URI: `/sdrangel/deviceset/{deviceSetIndex}`
- HTTP method: `GET`
- To select a device in a device set:
- Operation ID: `devicesetDevicePut`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device`
- HTTP method: `PUT`
- To get the settings of a device:
- OperationID: `devicesetDeviceSettingsGet`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/settings`
- HTTP method: `GET`
- To change the settings of a device:
- OperationID: `devicesetDeviceSettingsPatch`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/settings`
- HTTP method: `PATCH`
<h2>start_stop.py</h2>
Starts or stops a device in the specified device set
It uses the following APIs:
- Get information on device sets:
- Operation ID: `instanceDeviceSetsGet`
- URI: `/sdrangel/devicesets`
- HTTP method: `GET`
- Start a device streaming
- OperationID: `devicesetDeviceRunPost`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/run`
- HTTP method: `POST`
- Stop a device streaming
- OperationID: `devicesetDeviceRunDelete`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/run`
- HTTP method: `DELETE`