Difference between revisions of "Funcube Dongle command matrix"

From MyLabWiki
Jump to: navigation, search
m
(Add remaining commands)
 
(3 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
| align="right" | 1
 
| align="right" | 1
 
| FCD_CMD_BL_QUERY
 
| FCD_CMD_BL_QUERY
| Returns string with "FCDAPP version"
+
| colspan="2" | Returns string with "FCDAPP version"
| ?
+
 
|-
 
|-
 
| align="right" | 8
 
| align="right" | 8
Line 44: Line 43:
 
| align="right" | 100
 
| align="right" | 100
 
| FCD_CMD_APP_SET_FREQ_KHZ
 
| FCD_CMD_APP_SET_FREQ_KHZ
| 3 byte unsigned LE frequency in kHz
+
| colspan="2" | Send with 3 byte unsigned LE frequency in kHz
|
+
 
|-
 
|-
 
| align="right" | 101
 
| align="right" | 101
 
| FCD_CMD_APP_SET_FREQ_HZ
 
| FCD_CMD_APP_SET_FREQ_HZ
| 4 byte unsigned LE frequency in Hz, returns actual frequency
+
| colspan="2" | Send with 4 byte unsigned LE frequency in Hz, returns actual frequency in Hz
|
+
 
|-
 
|-
 
| align="right" | 102
 
| align="right" | 102
 
| FCD_CMD_APP_GET_FREQ_HZ
 
| FCD_CMD_APP_GET_FREQ_HZ
| Returns 4 byte unsigned LE in Hz
+
| colspan="2" | Returns 4 byte unsigned LE in Hz
|
+
 
|-
 
|-
 
| align="right" | 104
 
| align="right" | 104
 
| FCD_CMD_APP_GET_IF_RSSI
 
| FCD_CMD_APP_GET_IF_RSSI
| align="center" colspan="2" | Deprecated  
+
| colspan="2" | Deprecated  
 
|-
 
|-
 
| align="right" | 105
 
| align="right" | 105
Line 68: Line 64:
 
| align="right" | 106
 
| align="right" | 106
 
| FCD_CMD_APP_SET_DC_CORR
 
| FCD_CMD_APP_SET_DC_CORR
| 2 byte unsigned I correction followed by 2 byte unsigned Q correction
+
| 2 byte unsigned Ifollowed by 2 byte unsigned Q correction
 
| n/a
 
| n/a
 
|-
 
|-
 
| align="right" | 107
 
| align="right" | 107
 
| FCD_CMD_APP_GET_DC_CORR  
 
| FCD_CMD_APP_GET_DC_CORR  
| Returns 2 byte unsigned I correction followed by 2 byte unsigned Q correction
+
| Returns 2 byte I then 2 bytes Q correction
 
| n/a
 
| n/a
 
|-
 
|-
 
| align="right" | 108
 
| align="right" | 108
 
| FCD_CMD_APP_SET_IQ_CORR
 
| FCD_CMD_APP_SET_IQ_CORR
| Send with 2 byte signed phase correction followed by 2 byte unsigned gain correction
+
| Send with 2 byte signed phase followed by 2 byte unsigned gain correction
 
| n/a
 
| n/a
 
|-
 
|-
 
| align="right" | 109
 
| align="right" | 109
 
| FCD_CMD_APP_GET_IQ_CORR
 
| FCD_CMD_APP_GET_IQ_CORR
| Returns 2 byte signed phase correction followed by 2 byte unsigned gain correction
+
| Returns 2 byte signed phase followed by 2 byte unsigned gain correction
 
| n/a
 
| n/a
 
|-
 
|-
Line 89: Line 85:
 
| FCD_CMD_APP_SET_LNA_GAIN
 
| FCD_CMD_APP_SET_LNA_GAIN
 
| Send with 1 byte: 0-14
 
| Send with 1 byte: 0-14
|
+
| Send with 1 byte: 1=ON, 0=OFF
 
|-
 
|-
 
| align="right" | 111
 
| align="right" | 111
 
| FCD_CMD_APP_SET_LNA_ENHANCE
 
| FCD_CMD_APP_SET_LNA_ENHANCE
 
| Send with 1 byte: 0-7
 
| Send with 1 byte: 0-7
|
+
| n/a
 
|-
 
|-
 
| align="right" | 112
 
| align="right" | 112
 
| FCD_CMD_APP_SET_BAND
 
| FCD_CMD_APP_SET_BAND
 
| Send with 1 byte: 0-3
 
| Send with 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 113
 
| align="right" | 113
 
| FCD_CMD_APP_SET_RF_FILTER
 
| FCD_CMD_APP_SET_RF_FILTER
 
| Send with 1 byte: 0-15 (depends on band selection)
 
| Send with 1 byte: 0-15 (depends on band selection)
|
+
| Send with 1 byte: 0-10, see tuner_rf_filter_t
 
|-
 
|-
 
| align="right" | 114
 
| align="right" | 114
 
| FCD_CMD_APP_SET_MIXER_GAIN
 
| FCD_CMD_APP_SET_MIXER_GAIN
| Send with 1 byte: 0,1
+
| Send with 1 byte: 1=ON, 0=OFF
|
+
| Send with 1 byte: 1=ON, 0=OFF
 
|-
 
|-
 
| align="right" | 115
 
| align="right" | 115
 
| FCD_CMD_APP_SET_BIAS_CURRENT
 
| FCD_CMD_APP_SET_BIAS_CURRENT
 
| Send with 1 byte: 0-3
 
| Send with 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 116
 
| align="right" | 116
 
| FCD_CMD_APP_SET_MIXER_FILTER
 
| FCD_CMD_APP_SET_MIXER_FILTER
 
| Send with 1 byte: 0, 8-15
 
| Send with 1 byte: 0, 8-15
|
+
| n/a
 
|-
 
|-
 
| align="right" | 117
 
| align="right" | 117
 
| FCD_CMD_APP_SET_IF_GAIN1
 
| FCD_CMD_APP_SET_IF_GAIN1
 
| Send with 1 byte: 0,1
 
| Send with 1 byte: 0,1
|
+
| Send with 1 byte: 0-59 dB
 
|-
 
|-
 
| align="right" | 118
 
| align="right" | 118
 
| FCD_CMD_APP_SET_IF_GAIN_MODE
 
| FCD_CMD_APP_SET_IF_GAIN_MODE
 
| Send with 1 byte: 0,1
 
| Send with 1 byte: 0,1
|
+
| n/a
 
|-
 
|-
 
| align="right" | 119
 
| align="right" | 119
 
| FCD_CMD_APP_SET_IF_RC_FILTER
 
| FCD_CMD_APP_SET_IF_RC_FILTER
 
| Send with 1 byte: 0-15
 
| Send with 1 byte: 0-15
|
+
| n/a
 
|-
 
|-
 
| align="right" | 120
 
| align="right" | 120
 
| FCD_CMD_APP_SET_IF_GAIN2
 
| FCD_CMD_APP_SET_IF_GAIN2
 
| Send with 1 byte: 0-3
 
| Send with 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 121
 
| align="right" | 121
 
| FCD_CMD_APP_SET_IF_GAIN3
 
| FCD_CMD_APP_SET_IF_GAIN3
 
| Send with 1 byte: 0-3
 
| Send with 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 122
 
| align="right" | 122
 
| FCD_CMD_APP_SET_IF_FILTER
 
| FCD_CMD_APP_SET_IF_FILTER
 
| Send with 1 byte: 0-31
 
| Send with 1 byte: 0-31
|
+
| Send with 1 byte: 0-7, see tuner_if_filter_t
 
|-
 
|-
 
| align="right" | 123
 
| align="right" | 123
 
| FCD_CMD_APP_SET_IF_GAIN4
 
| FCD_CMD_APP_SET_IF_GAIN4
 
| Send with 1 byte: 0-2
 
| Send with 1 byte: 0-2
|
+
| n/a
 
|-
 
|-
 
| align="right" | 124
 
| align="right" | 124
 
| FCD_CMD_APP_SET_IF_GAIN5
 
| FCD_CMD_APP_SET_IF_GAIN5
 
| Send with 1 byte: 0-4
 
| Send with 1 byte: 0-4
|
+
| n/a
 
|-
 
|-
 
| align="right" | 125
 
| align="right" | 125
 
| FCD_CMD_APP_SET_IF_GAIN6
 
| FCD_CMD_APP_SET_IF_GAIN6
 
| Send with 1 byte: 0-4
 
| Send with 1 byte: 0-4
|
+
| n/a
 
|-
 
|-
 
| align="right" | 126
 
| align="right" | 126
 
| FCD_CMD_APP_SET_BIAS_TEE
 
| FCD_CMD_APP_SET_BIAS_TEE
| Send with 1 byte: 1=ON, 0=OFF
+
| colspan="2" |Send with 1 byte: 1=ON, 0=OFF
|
+
 
|-
 
|-
 
| align="right" | 150
 
| align="right" | 150
 
| FCD_CMD_APP_GET_LNA_GAIN
 
| FCD_CMD_APP_GET_LNA_GAIN
 
| Returns 1 byte: 0-14
 
| Returns 1 byte: 0-14
|
+
| Returns 1 byte: 1=ON, 0=OFF
 
|-
 
|-
 
| align="right" | 151
 
| align="right" | 151
 
| FCD_CMD_APP_GET_LNA_ENHANCE
 
| FCD_CMD_APP_GET_LNA_ENHANCE
|
+
| Returns 1 byte: 0-7
|
+
| n/a
 
|-
 
|-
 
| align="right" | 152
 
| align="right" | 152
 
| FCD_CMD_APP_GET_BAND
 
| FCD_CMD_APP_GET_BAND
|
+
| Returns 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 153
 
| align="right" | 153
 
| FCD_CMD_APP_GET_RF_FILTER
 
| FCD_CMD_APP_GET_RF_FILTER
|
+
| Returns 1 byte: 0-15 (depends on band selection)
|
+
| Returns 1 byte: 0-10, see tuner_rf_filter_t
 
|-
 
|-
 
| align="right" | 154
 
| align="right" | 154
 
| FCD_CMD_APP_GET_MIXER_GAIN
 
| FCD_CMD_APP_GET_MIXER_GAIN
|
+
| Returns 1 byte: 0,1
|
+
| Returns 1 byte: 1=ON, 0=OFF
 
|-
 
|-
 
| align="right" | 155
 
| align="right" | 155
 
| FCD_CMD_APP_GET_BIAS_CURRENT
 
| FCD_CMD_APP_GET_BIAS_CURRENT
|
+
| Returns 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 156
 
| align="right" | 156
 
| FCD_CMD_APP_GET_MIXER_FILTER
 
| FCD_CMD_APP_GET_MIXER_FILTER
|
+
| Returns 1 byte: 0, 8-15
|
+
| n/a
 
|-
 
|-
 
| align="right" | 157
 
| align="right" | 157
 
| FCD_CMD_APP_GET_IF_GAIN1
 
| FCD_CMD_APP_GET_IF_GAIN1
|
+
| Returns 1 byte: 0,1
|
+
| Returns 1 byte: 0-59 dB
 
|-
 
|-
 
| align="right" | 158
 
| align="right" | 158
 
| FCD_CMD_APP_GET_IF_GAIN_MODE
 
| FCD_CMD_APP_GET_IF_GAIN_MODE
|
+
| Returns 1 byte: 0,1
|
+
| n/a
 
|-
 
|-
 
| align="right" | 159
 
| align="right" | 159
 
| FCD_CMD_APP_GET_IF_RC_FILTER
 
| FCD_CMD_APP_GET_IF_RC_FILTER
|
+
| Returns 1 byte: 0-15
|
+
| n/a
 
|-
 
|-
 
| align="right" | 160
 
| align="right" | 160
 
| FCD_CMD_APP_GET_IF_GAIN2
 
| FCD_CMD_APP_GET_IF_GAIN2
|
+
| Returns 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 161
 
| align="right" | 161
 
| FCD_CMD_APP_GET_IF_GAIN3
 
| FCD_CMD_APP_GET_IF_GAIN3
|
+
| Returns 1 byte: 0-3
|
+
| n/a
 
|-
 
|-
 
| align="right" | 162
 
| align="right" | 162
 
| FCD_CMD_APP_GET_IF_FILTER
 
| FCD_CMD_APP_GET_IF_FILTER
|
+
| Returns 1 byte: 0-31
|
+
| Returns 1 byte: 0-7, see tuner_if_filter_t
 
|-
 
|-
 
| align="right" | 163
 
| align="right" | 163
 
| FCD_CMD_APP_GET_IF_GAIN4
 
| FCD_CMD_APP_GET_IF_GAIN4
|
+
| Returns 1 byte: 0-2
|
+
| n/a
 
|-
 
|-
 
| align="right" | 164
 
| align="right" | 164
 
| FCD_CMD_APP_GET_IF_GAIN5
 
| FCD_CMD_APP_GET_IF_GAIN5
|  
+
| Returns 1 byte: 0-4
|
+
| n/a
 
|-
 
|-
 
| align="right" | 165
 
| align="right" | 165
 
| FCD_CMD_APP_GET_IF_GAIN6
 
| FCD_CMD_APP_GET_IF_GAIN6
|
+
| Returns 1 byte: 0-4
|
+
| n/a
 
|-
 
|-
 
| align="right" | 166
 
| align="right" | 166
 
| FCD_CMD_APP_GET_BIAS_TEE
 
| FCD_CMD_APP_GET_BIAS_TEE
|
+
| colspan="2" | Returns 1 byte: 1=ON, 0=OFF
|
+
 
|-
 
|-
| align="right" |  
+
| align="right" | 200
|  
+
| FCD_CMD_APP_SEND_I2C_BYTE
|
+
 
|
 
|
 +
| n/a
 
|-
 
|-
| align="right" |  
+
| align="right" | 201
|
+
| FCD_CMD_APP_RECV_I2C_BYTE
|
+
 
|
 
|
 +
| n/a
 
|-
 
|-
| align="right" |  
+
| align="right" | 255
|
+
| FCD_CMD_APP_RESET
|
+
| colspan="2" | Reset to bootloader
|
+
 
|}
 
|}
  
 
[[Category:Funcube Dongle]]
 
[[Category:Funcube Dongle]]

Latest revision as of 22:45, 12 December 2012

This document gives a summary of the API commands supported by the Funcube Dongle Pro and Pro+ firmwares.

ID Command FCD Pro parameters FCD Pro+ parameters
1 FCD_CMD_BL_QUERY Returns string with "FCDAPP version"
8 FCD_CMD_BL_RESET Reset to application mode  ?
24 FCD_CMD_BL_ERASE Erase firmware from FCD flash  ?
25 FCD_CMD_BL_SET_BYTE_ADDR TBD  ?
26 FCD_CMD_BL_GET_BYTE_ADDR_RANGE Get address range  ?
27 FCD_CMD_BL_WRITE_FLASH_BLOCK Write flash block  ?
28 FCD_CMD_BL_READ_FLASH_BLOCK Read flash block  ?
100 FCD_CMD_APP_SET_FREQ_KHZ Send with 3 byte unsigned LE frequency in kHz
101 FCD_CMD_APP_SET_FREQ_HZ Send with 4 byte unsigned LE frequency in Hz, returns actual frequency in Hz
102 FCD_CMD_APP_GET_FREQ_HZ Returns 4 byte unsigned LE in Hz
104 FCD_CMD_APP_GET_IF_RSSI Deprecated
105 FCD_CMD_APP_GET_PLL_LOCK Returns 1 bit, true if locked n/a
106 FCD_CMD_APP_SET_DC_CORR 2 byte unsigned Ifollowed by 2 byte unsigned Q correction n/a
107 FCD_CMD_APP_GET_DC_CORR Returns 2 byte I then 2 bytes Q correction n/a
108 FCD_CMD_APP_SET_IQ_CORR Send with 2 byte signed phase followed by 2 byte unsigned gain correction n/a
109 FCD_CMD_APP_GET_IQ_CORR Returns 2 byte signed phase followed by 2 byte unsigned gain correction n/a
110 FCD_CMD_APP_SET_LNA_GAIN Send with 1 byte: 0-14 Send with 1 byte: 1=ON, 0=OFF
111 FCD_CMD_APP_SET_LNA_ENHANCE Send with 1 byte: 0-7 n/a
112 FCD_CMD_APP_SET_BAND Send with 1 byte: 0-3 n/a
113 FCD_CMD_APP_SET_RF_FILTER Send with 1 byte: 0-15 (depends on band selection) Send with 1 byte: 0-10, see tuner_rf_filter_t
114 FCD_CMD_APP_SET_MIXER_GAIN Send with 1 byte: 1=ON, 0=OFF Send with 1 byte: 1=ON, 0=OFF
115 FCD_CMD_APP_SET_BIAS_CURRENT Send with 1 byte: 0-3 n/a
116 FCD_CMD_APP_SET_MIXER_FILTER Send with 1 byte: 0, 8-15 n/a
117 FCD_CMD_APP_SET_IF_GAIN1 Send with 1 byte: 0,1 Send with 1 byte: 0-59 dB
118 FCD_CMD_APP_SET_IF_GAIN_MODE Send with 1 byte: 0,1 n/a
119 FCD_CMD_APP_SET_IF_RC_FILTER Send with 1 byte: 0-15 n/a
120 FCD_CMD_APP_SET_IF_GAIN2 Send with 1 byte: 0-3 n/a
121 FCD_CMD_APP_SET_IF_GAIN3 Send with 1 byte: 0-3 n/a
122 FCD_CMD_APP_SET_IF_FILTER Send with 1 byte: 0-31 Send with 1 byte: 0-7, see tuner_if_filter_t
123 FCD_CMD_APP_SET_IF_GAIN4 Send with 1 byte: 0-2 n/a
124 FCD_CMD_APP_SET_IF_GAIN5 Send with 1 byte: 0-4 n/a
125 FCD_CMD_APP_SET_IF_GAIN6 Send with 1 byte: 0-4 n/a
126 FCD_CMD_APP_SET_BIAS_TEE Send with 1 byte: 1=ON, 0=OFF
150 FCD_CMD_APP_GET_LNA_GAIN Returns 1 byte: 0-14 Returns 1 byte: 1=ON, 0=OFF
151 FCD_CMD_APP_GET_LNA_ENHANCE Returns 1 byte: 0-7 n/a
152 FCD_CMD_APP_GET_BAND Returns 1 byte: 0-3 n/a
153 FCD_CMD_APP_GET_RF_FILTER Returns 1 byte: 0-15 (depends on band selection) Returns 1 byte: 0-10, see tuner_rf_filter_t
154 FCD_CMD_APP_GET_MIXER_GAIN Returns 1 byte: 0,1 Returns 1 byte: 1=ON, 0=OFF
155 FCD_CMD_APP_GET_BIAS_CURRENT Returns 1 byte: 0-3 n/a
156 FCD_CMD_APP_GET_MIXER_FILTER Returns 1 byte: 0, 8-15 n/a
157 FCD_CMD_APP_GET_IF_GAIN1 Returns 1 byte: 0,1 Returns 1 byte: 0-59 dB
158 FCD_CMD_APP_GET_IF_GAIN_MODE Returns 1 byte: 0,1 n/a
159 FCD_CMD_APP_GET_IF_RC_FILTER Returns 1 byte: 0-15 n/a
160 FCD_CMD_APP_GET_IF_GAIN2 Returns 1 byte: 0-3 n/a
161 FCD_CMD_APP_GET_IF_GAIN3 Returns 1 byte: 0-3 n/a
162 FCD_CMD_APP_GET_IF_FILTER Returns 1 byte: 0-31 Returns 1 byte: 0-7, see tuner_if_filter_t
163 FCD_CMD_APP_GET_IF_GAIN4 Returns 1 byte: 0-2 n/a
164 FCD_CMD_APP_GET_IF_GAIN5 Returns 1 byte: 0-4 n/a
165 FCD_CMD_APP_GET_IF_GAIN6 Returns 1 byte: 0-4 n/a
166 FCD_CMD_APP_GET_BIAS_TEE Returns 1 byte: 1=ON, 0=OFF
200 FCD_CMD_APP_SEND_I2C_BYTE n/a
201 FCD_CMD_APP_RECV_I2C_BYTE n/a
255 FCD_CMD_APP_RESET Reset to bootloader