?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Fix doc path
[opentx.git] / companion / src / firmwares / modeldata.cpp
blobc2c69ee1655d5ef3ba71a02fc6a616b835d54e53
1 /*
2 * Copyright (C) OpenTX
3 *
4 * Based on code named
5 * th9x - http://code.google.com/p/th9x
6 * er9x - http://code.google.com/p/er9x
7 * gruvin9x - http://code.google.com/p/gruvin9x
8 *
9 * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 */
20
21 #include "modeldata.h"
22
23 #include "eeprominterface.h"
24 #include "generalsettings.h"
25 #include "macros.h"
26 #include "radiodataconversionstate.h"
27
28
29 QString removeAccents(const QString & str)
30 {
31 QString result = str;
32
33 // UTF-8 ASCII Table
34 const QString tA[] = { "á", "â", "ã", "à", "ä" };
35 const QString tE[] = { "é", "è", "ê", "ě" };
36 const QString tI[] = { "í" };
37 const QString tO[] = { "ó", "ô", "õ", "ö" };
38 const QString tU[] = { "ú", "ü" };
39 const QString tC[] = { "ç" };
40 const QString tY[] = { "ý" };
41 const QString tS[] = { "š" };
42 const QString tR[] = { "ř" };
43
44 for (unsigned int i = 0; i < DIM(tA); i++) result.replace(tA[i], "a");
45 for (unsigned int i = 0; i < DIM(tE); i++) result.replace(tE[i], "e");
46 for (unsigned int i = 0; i < DIM(tI); i++) result.replace(tI[i], "i");
47 for (unsigned int i = 0; i < DIM(tO); i++) result.replace(tO[i], "o");
48 for (unsigned int i = 0; i < DIM(tU); i++) result.replace(tU[i], "u");
49 for (unsigned int i = 0; i < DIM(tC); i++) result.replace(tC[i], "c");
50 for (unsigned int i = 0; i < DIM(tY); i++) result.replace(tY[i], "y");
51 for (unsigned int i = 0; i < DIM(tS); i++) result.replace(tS[i], "s");
52 for (unsigned int i = 0; i < DIM(tR); i++) result.replace(tR[i], "r");
53
54 return result;
55 }
56
57
58 /*
59 * TimerData
60 */
61
62 void TimerData::convert(RadioDataConversionState & cstate)
63 {
64 cstate.setComponent(tr("TMR"), 1);
65 cstate.setSubComp(tr("Timer %1").arg(cstate.subCompIdx + 1));
66 mode.convert(cstate);
67 }
68
69
70 /*
71 * ModelData
72 */
73
74 ModelData::ModelData()
75 {
76 clear();
77 }
78
79 ModelData::ModelData(const ModelData & src)
80 {
81 *this = src;
82 }
83
84 ModelData & ModelData::operator = (const ModelData & src)
85 {
86 memcpy(this, &src, sizeof(ModelData));
87 return *this;
88 }
89
90 ExpoData * ModelData::insertInput(const int idx)
91 {
92 memmove(&expoData[idx+1], &expoData[idx], (CPN_MAX_EXPOS-(idx+1))*sizeof(ExpoData));
93 expoData[idx].clear();
94 return &expoData[idx];
95 }
96
97 bool ModelData::isInputValid(const unsigned int idx) const
98 {
99 for (int i=0; i<CPN_MAX_EXPOS; i++) {
100 const ExpoData * expo = &expoData[i];
101 if (expo->mode == 0) break;
102 if (expo->chn == idx)
103 return true;
104 }
105 return false;
106 }
107
108 bool ModelData::hasExpos(uint8_t inputIdx) const
109 {
110 for (int i=0; i<CPN_MAX_EXPOS; i++) {
111 const ExpoData & expo = expoData[i];
112 if (expo.chn==inputIdx && expo.mode!=0) {
113 return true;
114 }
115 }
116 return false;
117 }
118
119 bool ModelData::hasMixes(uint8_t channelIdx) const
120 {
121 channelIdx += 1;
122 for (int i=0; i<CPN_MAX_MIXERS; i++) {
123 if (mixData[i].destCh == channelIdx) {
124 return true;
125 }
126 }
127 return false;
128 }
129
130 QVector<const ExpoData *> ModelData::expos(int input) const
131 {
132 QVector<const ExpoData *> result;
133 for (int i=0; i<CPN_MAX_EXPOS; i++) {
134 const ExpoData * ed = &expoData[i];
135 if ((int)ed->chn==input && ed->mode!=0) {
136 result << ed;
137 }
138 }
139 return result;
140 }
141
142 QVector<const MixData *> ModelData::mixes(int channel) const
143 {
144 QVector<const MixData *> result;
145 for (int i=0; i<CPN_MAX_MIXERS; i++) {
146 const MixData * md = &mixData[i];
147 if ((int)md->destCh == channel+1) {
148 result << md;
149 }
150 }
151 return result;
152 }
153
154 void ModelData::removeInput(const int idx, bool clearName)
155 {
156 unsigned int chn = expoData[idx].chn;
157
158 memmove(&expoData[idx], &expoData[idx+1], (CPN_MAX_EXPOS-(idx+1))*sizeof(ExpoData));
159 expoData[CPN_MAX_EXPOS-1].clear();
160
161 //also remove input name if removing last line for this input
162 if (clearName && !expos(chn).size())
163 inputNames[chn][0] = 0;
164 }
165
166 void ModelData::clearInputs()
167 {
168 for (int i=0; i<CPN_MAX_EXPOS; i++)
169 expoData[i].clear();
170
171 //clear all input names
172 if (getCurrentFirmware()->getCapability(VirtualInputs)) {
173 for (int i=0; i<CPN_MAX_INPUTS; i++) {
174 inputNames[i][0] = 0;
175 }
176 }
177 }
178
179 void ModelData::clearMixes()
180 {
181 for (int i=0; i<CPN_MAX_MIXERS; i++)
182 mixData[i].clear();
183 }
184
185 void ModelData::clear()
186 {
187 memset(this, 0, sizeof(ModelData));
188 modelIndex = -1; // an invalid index, this is managed by the TreeView data model
189 moduleData[0].channelsCount = 8;
190 moduleData[1].channelsStart = 0;
191 moduleData[1].channelsCount = 8;
192 moduleData[0].ppm.delay = 300;
193 moduleData[1].ppm.delay = 300;
194 moduleData[2].ppm.delay = 300;
195 int board = getCurrentBoard();
196 if (IS_HORUS_OR_TARANIS(board)) {
197 moduleData[0].protocol = PULSES_PXX_XJT_X16;
198 moduleData[1].protocol = PULSES_OFF;
199 }
200 else if (IS_SKY9X(board)) {
201 moduleData[0].protocol = PULSES_PPM;
202 moduleData[1].protocol = PULSES_PPM;
203 }
204 else {
205 moduleData[0].protocol = PULSES_PPM;
206 moduleData[1].protocol = PULSES_OFF;
207 }
208 for (int i=0; i<CPN_MAX_FLIGHT_MODES; i++) {
209 flightModeData[i].clear(i);
210 }
211 for (int i=0; i<CPN_MAX_GVARS; i++) {
212 gvarData[i].clear();
213 }
214 clearInputs();
215 clearMixes();
216 for (int i=0; i<CPN_MAX_CHNOUT; i++)
217 limitData[i].clear();
218 for (int i=0; i<CPN_MAX_STICKS; i++)
219 expoData[i].clear();
220 for (int i=0; i<CPN_MAX_LOGICAL_SWITCHES; i++)
221 logicalSw[i].clear();
222 for (int i=0; i<CPN_MAX_SPECIAL_FUNCTIONS; i++)
223 customFn[i].clear();
224 for (int i=0; i<CPN_MAX_CURVES; i++)
225 curves[i].clear(5);
226 for (int i=0; i<CPN_MAX_TIMERS; i++)
227 timers[i].clear();
228 swashRingData.clear();
229 frsky.clear();
230 rssiAlarms.clear();
231 for (int i=0; i<CPN_MAX_SENSORS; i++)
232 sensorData[i].clear();
233
234 static const uint8_t blob[] = { 0x4c, 0x61, 0x79, 0x6f, 0x75, 0x74, 0x32, 0x50, 0x31, 0x00, 0x4d, 0x6f, 0x64, 0x65, 0x6c, 0x42, 0x6d, 0x70, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
235 memcpy(customScreenData[0], blob, sizeof(blob));
236 }
237
238 bool ModelData::isEmpty() const
239 {
240 return !used;
241 }
242
243 void ModelData::setDefaultInputs(const GeneralSettings & settings)
244 {
245 Board::Type board = getCurrentBoard();
246 if (IS_ARM(board)) {
247 for (int i=0; i<CPN_MAX_STICKS; i++) {
248 ExpoData * expo = &expoData[i];
249 expo->chn = i;
250 expo->mode = INPUT_MODE_BOTH;
251 expo->srcRaw = settings.getDefaultSource(i);
252 expo->weight = 100;
253 strncpy(inputNames[i], removeAccents(expo->srcRaw.toString(this)).toLatin1().constData(), sizeof(inputNames[i])-1);
254 }
255 }
256 }
257
258 void ModelData::setDefaultMixes(const GeneralSettings & settings)
259 {
260 Board::Type board = getCurrentBoard();
261 if (IS_ARM(board)) {
262 setDefaultInputs(settings);
263 }
264
265 for (int i=0; i<CPN_MAX_STICKS; i++) {
266 MixData * mix = &mixData[i];
267 mix->destCh = i+1;
268 mix->weight = 100;
269 if (IS_ARM(board)) {
270 mix->srcRaw = RawSource(SOURCE_TYPE_VIRTUAL_INPUT, i);
271 }
272 else {
273 mix->srcRaw = RawSource(SOURCE_TYPE_STICK, i);
274 }
275 }
276 }
277
278 void ModelData::setDefaultValues(unsigned int id, const GeneralSettings & settings)
279 {
280 clear();
281 used = true;
282 sprintf(name, "MODEL%02d", id+1);
283 for (int i=0; i<CPN_MAX_MODULES; i++) {
284 moduleData[i].modelId = id+1;
285 }
286 setDefaultMixes(settings);
287 }
288
289 int ModelData::getTrimValue(int phaseIdx, int trimIdx)
290 {
291 int result = 0;
292 for (int i=0; i<CPN_MAX_FLIGHT_MODES; i++) {
293 FlightModeData & phase = flightModeData[phaseIdx];
294 if (phase.trimMode[trimIdx] < 0) {
295 return result;
296 }
297 else {
298 if (phase.trimRef[trimIdx] == phaseIdx || phaseIdx == 0) {
299 return result + phase.trim[trimIdx];
300 }
301 else {
302 phaseIdx = phase.trimRef[trimIdx];
303 if (phase.trimMode[trimIdx] != 0)
304 result += phase.trim[trimIdx];
305 }
306 }
307 }
308 return 0;
309 }
310
311 bool ModelData::isGVarLinked(int phaseIdx, int gvarIdx)
312 {
313 return flightModeData[phaseIdx].gvars[gvarIdx] > 1024;
314 }
315
316 int ModelData::getGVarFieldValue(int phaseIdx, int gvarIdx)
317 {
318 int idx = flightModeData[phaseIdx].gvars[gvarIdx];
319 for (int i=0; idx>GVAR_MAX_VALUE && i<CPN_MAX_FLIGHT_MODES; i++) {
320 int nextPhase = idx - GVAR_MAX_VALUE - 1;
321 if (nextPhase >= phaseIdx) nextPhase += 1;
322 phaseIdx = nextPhase;
323 idx = flightModeData[phaseIdx].gvars[gvarIdx];
324 }
325 return idx;
326 }
327
328 void ModelData::setTrimValue(int phaseIdx, int trimIdx, int value)
329 {
330 for (uint8_t i=0; i<CPN_MAX_FLIGHT_MODES; i++) {
331 FlightModeData & phase = flightModeData[phaseIdx];
332 int mode = phase.trimMode[trimIdx];
333 int p = phase.trimRef[trimIdx];
334 int & trim = phase.trim[trimIdx];
335 if (mode < 0)
336 return;
337 if (p == phaseIdx || phaseIdx == 0) {
338 trim = value;
339 break;;
340 }
341 else if (mode == 0) {
342 phaseIdx = p;
343 }
344 else {
345 trim = value - getTrimValue(p, trimIdx);
346 if (trim < -500)
347 trim = -500;
348 if (trim > 500)
349 trim = 500;
350 break;
351 }
352 }
353 }
354
355 void ModelData::removeGlobalVar(int & var)
356 {
357 if (var >= 126 && var <= 130)
358 var = flightModeData[0].gvars[var-126];
359 else if (var <= -126 && var >= -130)
360 var = - flightModeData[0].gvars[-126-var];
361 }
362
363 ModelData ModelData::removeGlobalVars()
364 {
365 ModelData result = *this;
366
367 for (int i=0; i<CPN_MAX_MIXERS; i++) {
368 removeGlobalVar(mixData[i].weight);
369 removeGlobalVar(mixData[i].curve.value);
370 removeGlobalVar(mixData[i].sOffset);
371 }
372
373 for (int i=0; i<CPN_MAX_EXPOS; i++) {
374 removeGlobalVar(expoData[i].weight);
375 removeGlobalVar(expoData[i].curve.value);
376 }
377
378 return result;
379 }
380
381 int ModelData::getChannelsMax(bool forceExtendedLimits) const
382 {
383 if (forceExtendedLimits || extendedLimits)
384 return IS_HORUS_OR_TARANIS(getCurrentBoard()) ? 150 : 125;
385 else
386 return 100;
387 }
388
389 bool ModelData::isAvailable(const RawSwitch & swtch) const
390 {
391 unsigned index = abs(swtch.index) - 1;
392
393 if (swtch.type == SWITCH_TYPE_VIRTUAL) {
394 return logicalSw[index].func != LS_FN_OFF;
395 }
396 else if (swtch.type == SWITCH_TYPE_FLIGHT_MODE) {
397 return index == 0 || flightModeData[index].swtch.type != SWITCH_TYPE_NONE;
398 }
399 else if (swtch.type == SWITCH_TYPE_SENSOR) {
400 return strlen(sensorData[index].label) > 0;
401 }
402 else {
403 return true;
404 }
405 }
406
407 float ModelData::getGVarFieldValuePrec(int phaseIdx, int gvarIdx)
408 {
409 return getGVarFieldValue(phaseIdx, gvarIdx) * gvarData[gvarIdx].multiplierGet();
410 }
411
412 void ModelData::convert(RadioDataConversionState & cstate)
413 {
414 // Here we can add explicit conversions when moving from one board to another
415
416 QString origin = QString(name);
417 if (origin.isEmpty())
418 origin = QString::number(cstate.modelIdx+1);
419 cstate.setOrigin(tr("Model: ") % origin);
420
421 cstate.setComponent("SET", 0);
422 if (thrTraceSrc && (int)thrTraceSrc < cstate.fromBoard.getCapability(Board::Pots) + cstate.fromBoard.getCapability(Board::Sliders)) {
423 cstate.setSubComp(tr("Throttle Source"));
424 thrTraceSrc = RawSource(SOURCE_TYPE_STICK, (int)thrTraceSrc + 3).convert(cstate).index - 3;
425 }
426
427 for (int i=0; i<CPN_MAX_TIMERS; i++) {
428 timers[i].convert(cstate.withComponentIndex(i));
429 }
430
431 for (int i=0; i<CPN_MAX_MIXERS; i++) {
432 mixData[i].convert(cstate.withComponentIndex(i));
433 }
434
435 for (int i=0; i<CPN_MAX_EXPOS; i++) {
436 expoData[i].convert(cstate.withComponentIndex(i));
437 }
438
439 for (int i=0; i<CPN_MAX_LOGICAL_SWITCHES; i++) {
440 logicalSw[i].convert(cstate.withComponentIndex(i));
441 }
442
443 for (int i=0; i<CPN_MAX_SPECIAL_FUNCTIONS; i++) {
444 customFn[i].convert(cstate.withComponentIndex(i));
445 }
446
447 for (int i=0; i<CPN_MAX_FLIGHT_MODES; i++) {
448 flightModeData[i].convert(cstate.withComponentIndex(i));
449 }
450
451 for (int i=0; i<CPN_MAX_MODULES; i++) {
452 moduleData[i].convert(cstate.withComponentIndex(i));
453 }
454 }
OpenTX is open source firmware for RC radio transmitters.