Files
edgetx-gx12/radio/src/telemetry/frsky_sport.cpp
T
Arne SchwabeandBertrand Songis 352de89838 Spektrum telemetry implementation (#3659)
* Implementation of Spektrum Telemetry for the DYI Multimodule.

I can only test a subset of sensors and these look okay

* Implement conversion from Fahrenheit to Celsius

* Minor fixes for Spektrum telemetry

* Add some more sensors, show sensor ID instead of instance in the overview
2016-07-22 17:38:11 +02:00

597 lines
17 KiB
C++

/*
* Copyright (C) OpenTX
*
* Based on code named
* th9x - http://code.google.com/p/th9x
* er9x - http://code.google.com/p/er9x
* gruvin9x - http://code.google.com/p/gruvin9x
*
* License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
#include "opentx.h"
#define PRIM_REQ_POWERUP (0)
#define PRIM_REQ_VERSION (1)
#define PRIM_CMD_DOWNLOAD (3)
#define PRIM_DATA_WORD (4)
#define PRIM_DATA_EOF (5)
#define PRIM_ACK_POWERUP (0x80)
#define PRIM_ACK_VERSION (0x81)
#define PRIM_REQ_DATA_ADDR (0x82)
#define PRIM_END_DOWNLOAD (0x83)
#define PRIM_DATA_CRC_ERR (0x84)
struct FrSkySportSensor {
const uint16_t firstId;
const uint16_t lastId;
const uint8_t subId;
const char * name;
const TelemetryUnit unit;
const uint8_t prec;
};
const FrSkySportSensor sportSensors[] = {
{ RSSI_ID, RSSI_ID, 0, ZSTR_RSSI, UNIT_DB, 0 },
{ ADC1_ID, ADC1_ID, 0, ZSTR_A1, UNIT_VOLTS, 1 },
{ ADC2_ID, ADC2_ID, 0, ZSTR_A2, UNIT_VOLTS, 1 },
{ A3_FIRST_ID, A3_LAST_ID, 0, ZSTR_A3, UNIT_VOLTS, 2 },
{ A4_FIRST_ID, A4_LAST_ID, 0, ZSTR_A4, UNIT_VOLTS, 2 },
{ BATT_ID, BATT_ID, 0, ZSTR_BATT, UNIT_VOLTS, 1 },
{ T1_FIRST_ID, T1_LAST_ID, 0, ZSTR_TEMP1, UNIT_CELSIUS, 0 },
{ T2_FIRST_ID, T2_LAST_ID, 0, ZSTR_TEMP2, UNIT_CELSIUS, 0 },
{ RPM_FIRST_ID, RPM_LAST_ID, 0, ZSTR_RPM, UNIT_RPMS, 0 },
{ FUEL_FIRST_ID, FUEL_LAST_ID, 0, ZSTR_FUEL, UNIT_PERCENT, 0 },
{ ALT_FIRST_ID, ALT_LAST_ID, 0, ZSTR_ALT, UNIT_METERS, 2 },
{ VARIO_FIRST_ID, VARIO_LAST_ID, 0, ZSTR_VSPD, UNIT_METERS_PER_SECOND, 2 },
{ ACCX_FIRST_ID, ACCX_LAST_ID, 0, ZSTR_ACCX, UNIT_G, 2 },
{ ACCY_FIRST_ID, ACCY_LAST_ID, 0, ZSTR_ACCY, UNIT_G, 2 },
{ ACCZ_FIRST_ID, ACCZ_LAST_ID, 0, ZSTR_ACCZ, UNIT_G, 2 },
{ CURR_FIRST_ID, CURR_LAST_ID, 0, ZSTR_CURR, UNIT_AMPS, 1 },
{ VFAS_FIRST_ID, VFAS_LAST_ID, 0, ZSTR_VFAS, UNIT_VOLTS, 2 },
{ AIR_SPEED_FIRST_ID, AIR_SPEED_LAST_ID, 0, ZSTR_ASPD, UNIT_KTS, 1 },
{ GPS_SPEED_FIRST_ID, GPS_SPEED_LAST_ID, 0, ZSTR_GSPD, UNIT_KTS, 3 },
{ CELLS_FIRST_ID, CELLS_LAST_ID, 0, ZSTR_CELLS, UNIT_CELLS, 2 },
{ GPS_ALT_FIRST_ID, GPS_ALT_LAST_ID, 0, ZSTR_GPSALT, UNIT_METERS, 2 },
{ GPS_TIME_DATE_FIRST_ID, GPS_TIME_DATE_LAST_ID, 0, ZSTR_GPSDATETIME, UNIT_DATETIME, 0 },
{ GPS_LONG_LATI_FIRST_ID, GPS_LONG_LATI_LAST_ID, 0, ZSTR_GPS, UNIT_GPS_LATITUDE, 0 },
{ GPS_LONG_LATI_FIRST_ID, GPS_LONG_LATI_LAST_ID, 1, ZSTR_GPS, UNIT_GPS_LONGITUDE, 0 },
{ FUEL_QTY_FIRST_ID, FUEL_QTY_LAST_ID, 0, ZSTR_FUEL, UNIT_MILLILITERS, 2 },
{ GPS_COURS_FIRST_ID, GPS_COURS_LAST_ID, 0, ZSTR_HDG, UNIT_DEGREE, 2 },
{ RBOX_BATT1_FIRST_ID, RBOX_BATT1_LAST_ID, 0, ZSTR_BATT1_VOLTAGE, UNIT_VOLTS, 3 },
{ RBOX_BATT2_FIRST_ID, RBOX_BATT2_LAST_ID, 0, ZSTR_BATT2_VOLTAGE, UNIT_VOLTS, 3 },
{ RBOX_BATT1_FIRST_ID, RBOX_BATT1_LAST_ID, 1, ZSTR_BATT1_CURRENT, UNIT_AMPS, 2 },
{ RBOX_BATT2_FIRST_ID, RBOX_BATT2_LAST_ID, 1, ZSTR_BATT2_CURRENT, UNIT_AMPS, 2 },
{ RBOX_CNSP_FIRST_ID, RBOX_CNSP_LAST_ID, 0, ZSTR_BATT1_CONSUMPTION, UNIT_MAH, 0 },
{ RBOX_CNSP_FIRST_ID, RBOX_CNSP_LAST_ID, 1, ZSTR_BATT2_CONSUMPTION, UNIT_MAH, 0 },
{ RBOX_STATE_FIRST_ID, RBOX_STATE_LAST_ID, 0, ZSTR_CHANS_STATE, UNIT_BITFIELD, 0 },
{ RBOX_STATE_FIRST_ID, RBOX_STATE_LAST_ID, 1, ZSTR_RB_STATE, UNIT_BITFIELD, 0 },
{ 0, 0, 0, NULL, UNIT_RAW, 0 } // sentinel
};
const FrSkySportSensor * getFrSkySportSensor(uint16_t id, uint8_t subId=0)
{
const FrSkySportSensor * result = NULL;
for (const FrSkySportSensor * sensor = sportSensors; sensor->firstId; sensor++) {
if (id >= sensor->firstId && id <= sensor->lastId && subId == sensor->subId) {
result = sensor;
break;
}
}
return result;
}
bool checkSportPacket(uint8_t *packet)
{
short crc = 0;
for (int i=1; i<FRSKY_SPORT_PACKET_SIZE; ++i) {
crc += packet[i]; // 0-1FE
crc += crc >> 8; // 0-1FF
crc &= 0x00ff; // 0-FF
}
// TRACE("crc: 0x%02x", crc);
return (crc == 0x00ff);
}
#define SPORT_DATA_U8(packet) (packet[4])
#define SPORT_DATA_S32(packet) (*((int32_t *)(packet+4)))
#define SPORT_DATA_U32(packet) (*((uint32_t *)(packet+4)))
#define HUB_DATA_U16(packet) (*((uint16_t *)(packet+4)))
enum SportUpdateState {
SPORT_IDLE,
SPORT_POWERUP_REQ,
SPORT_POWERUP_ACK,
SPORT_VERSION_REQ,
SPORT_VERSION_ACK,
SPORT_DATA_TRANSFER,
SPORT_DATA_REQ,
SPORT_COMPLETE,
SPORT_FAIL
};
uint8_t sportUpdateState = SPORT_IDLE;
uint32_t sportUpdateAddr = 0;
bool intPwr, extPwr;
uint16_t servosState;
uint16_t rboxState;
void processSportUpdatePacket(uint8_t * packet)
{
if (packet[0]==0x5E && packet[1]==0x50) {
switch (packet[2]) {
case PRIM_ACK_POWERUP :
if (sportUpdateState == SPORT_POWERUP_REQ) {
sportUpdateState = SPORT_POWERUP_ACK;
}
break;
case PRIM_ACK_VERSION:
if (sportUpdateState == SPORT_VERSION_REQ) {
sportUpdateState = SPORT_VERSION_ACK;
// SportVersion[0] = packet[3] ;
// SportVersion[1] = packet[4] ;
// SportVersion[2] = packet[5] ;
// SportVersion[3] = packet[6] ;
// SportVerValid = 1 ;
}
break;
case PRIM_REQ_DATA_ADDR :
if (sportUpdateState == SPORT_DATA_TRANSFER) {
sportUpdateAddr = *((uint32_t *)(&packet[3]));
sportUpdateState = SPORT_DATA_REQ;
}
break;
case PRIM_END_DOWNLOAD :
sportUpdateState = SPORT_COMPLETE ;
break;
case PRIM_DATA_CRC_ERR :
sportUpdateState = SPORT_FAIL ;
break;
}
}
}
void processSportPacket(uint16_t id, uint8_t subId, uint8_t instance, uint32_t data)
{
const FrSkySportSensor * sensor = getFrSkySportSensor(id, subId);
TelemetryUnit unit = UNIT_RAW;
uint8_t precision = 0;
if (sensor) {
unit = sensor->unit;
precision = sensor->prec;
}
if (unit == UNIT_CELLS) {
uint8_t cellsCount = (data & 0xF0) >> 4;
uint8_t cellIndex = (data & 0x0F);
uint32_t mask = (cellsCount << 24) + (cellIndex << 16);
setTelemetryValue(TELEM_PROTO_FRSKY_SPORT, id, subId, instance, mask + (((data & 0x000FFF00) >> 8) / 5), unit, precision);
if (cellIndex+1 < cellsCount) {
mask += (1 << 16);
setTelemetryValue(TELEM_PROTO_FRSKY_SPORT, id, subId, instance, mask + (((data & 0xFFF00000) >> 20) / 5), unit, precision);
}
}
else {
setTelemetryValue(TELEM_PROTO_FRSKY_SPORT, id, subId, instance, data, unit, precision);
}
}
void sportOutputPushByte(uint8_t byte)
{
if (byte == 0x7E || byte == 0x7D) {
telemetryOutputPushByte(0x7D);
telemetryOutputPushByte(0x20 ^ byte);
}
else {
telemetryOutputPushByte(byte);
}
}
bool isSportOutputBufferAvailable()
{
return (outputTelemetryBufferSize == 0 && outputTelemetryBufferTrigger == 0x7E);
}
// TODO merge it with S.PORT update function when finished
void sportOutputPushPacket(SportTelemetryPacket & packet)
{
uint16_t crc = 0;
for (uint8_t i=1; i<sizeof(packet); i++) {
uint8_t byte = packet.raw[i];
sportOutputPushByte(byte);
crc += byte; // 0-1FF
crc += crc >> 8; // 0-100
crc &= 0x00ff;
}
telemetryOutputPushByte(0xFF-crc);
telemetryOutputSetTrigger(packet.raw[0]); // physicalId
}
void processSportPacket(uint8_t * packet)
{
uint8_t physicalId = packet[0] & 0x1F;
uint8_t primId = packet[1];
uint16_t id = *((uint16_t *)(packet+2));
uint32_t data = SPORT_DATA_S32(packet);
#if defined(CPUSTM32) && !defined(SIMU)
if (sportUpdateState != SPORT_IDLE) {
processSportUpdatePacket(packet); // Uses different chksum
return;
}
#endif
if (!checkSportPacket(packet)) {
TRACE("processSportPacket(): checksum error ");
DUMP(packet, FRSKY_SPORT_PACKET_SIZE);
return;
}
if (primId == DATA_FRAME) {
uint8_t instance = physicalId + 1;
if (id == RSSI_ID) {
telemetryStreaming = TELEMETRY_TIMEOUT10ms; // reset counter only if valid packets are being detected
data = SPORT_DATA_U8(packet);
if (data == 0)
telemetryData.rssi.reset();
else
telemetryData.rssi.set(data);
}
#if defined(PCBTARANIS) && defined(REVPLUS)
else if (id == XJT_VERSION_ID) {
telemetryData.xjtVersion = HUB_DATA_U16(packet);
if (!IS_VALID_XJT_VERSION()) {
telemetryData.swr.set(0x00);
}
}
else if (id == SWR_ID) {
if (IS_VALID_XJT_VERSION())
telemetryData.swr.set(SPORT_DATA_U8(packet));
else
telemetryData.swr.set(0x00);
}
#else
else if (id == XJT_VERSION_ID) {
telemetryData.xjtVersion = HUB_DATA_U16(packet);
}
else if (id == SWR_ID) {
telemetryData.swr.set(SPORT_DATA_U8(packet));
}
#endif
if (TELEMETRY_STREAMING()/* because when Rx is OFF it happens that some old A1/A2 values are sent from the XJT module*/) {
if ((id >> 8) == 0) {
// The old FrSky IDs
processHubPacket(id, HUB_DATA_U16(packet));
}
else if (!IS_HIDDEN_TELEMETRY_VALUE(id)) {
if (id == ADC1_ID || id == ADC2_ID || id == BATT_ID || id == SWR_ID) {
data = SPORT_DATA_U8(packet);
}
if (id >= GPS_LONG_LATI_FIRST_ID && id <= GPS_LONG_LATI_LAST_ID) {
int32_t value = (data & 0x3fffffff);
if (data & (1 << 30))
value = -value;
value = (value * 5) / 3; // min/10000 => deg/1000000
if (data & (1 << 31))
processSportPacket(id, 0, instance, value); // latitude
else
processSportPacket(id, 1, instance, value); // longitude
}
else if (id >= RBOX_BATT1_FIRST_ID && id <= RBOX_BATT2_LAST_ID) {
processSportPacket(id, 0, instance, data & 0xffff);
processSportPacket(id, 1, instance, data >> 16);
}
else if (id >= RBOX_CNSP_FIRST_ID && id <= RBOX_CNSP_LAST_ID) {
processSportPacket(id, 0, instance, data & 0xffff);
processSportPacket(id, 1, instance, data >> 16);
}
else if (id >= RBOX_STATE_FIRST_ID && id <= RBOX_STATE_LAST_ID) {
uint16_t newServosState = data & 0xffff;
if (newServosState != 0 && servosState == 0) {
audioEvent(AU_SERVO_KO);
}
uint16_t newRboxState = data >> 16;
if ((newRboxState & 0x07) && (rboxState & 0x07) == 0) {
audioEvent(AU_RX_OVERLOAD);
}
servosState = newServosState;
rboxState = newRboxState;
processSportPacket(id, 0, instance, servosState);
processSportPacket(id, 1, instance, rboxState);
}
else if (id >= DIY_FIRST_ID && id <= DIY_LAST_ID) {
#if defined(LUA)
if (luaInputTelemetryFifo) {
SportTelemetryPacket luaPacket;
luaPacket.physicalId = physicalId;
luaPacket.primId = primId;
luaPacket.dataId = id;
luaPacket.value = data;
for (uint8_t i=0; i<sizeof(luaPacket); i++) {
luaInputTelemetryFifo->push(luaPacket.raw[i]);
}
}
#endif
}
else {
processSportPacket(id, 0, instance, data);
}
}
}
}
#if defined(LUA)
else if (primId == 0x32) {
if (luaInputTelemetryFifo) {
SportTelemetryPacket luaPacket;
luaPacket.physicalId = physicalId;
luaPacket.primId = primId;
luaPacket.dataId = id;
luaPacket.value = data;
for (uint8_t i=0; i<sizeof(luaPacket); i++) {
luaInputTelemetryFifo->push(luaPacket.raw[i]);
}
}
}
#endif
}
void frskySportSetDefault(int index, uint16_t id, uint8_t subId, uint8_t instance)
{
TelemetrySensor & telemetrySensor = g_model.telemetrySensors[index];
telemetrySensor.id = id;
telemetrySensor.subId = subId;
telemetrySensor.instance = instance;
const FrSkySportSensor * sensor = getFrSkySportSensor(id, subId);
if (sensor) {
TelemetryUnit unit = sensor->unit;
uint8_t prec = min<uint8_t>(2, sensor->prec);
telemetrySensor.init(sensor->name, unit, prec);
if (id == RSSI_ID) {
telemetrySensor.logs = true;
}
else if (id >= ADC1_ID && id <= BATT_ID) {
telemetrySensor.custom.ratio = 132;
telemetrySensor.filter = 1;
}
else if (id >= CURR_FIRST_ID && id <= CURR_LAST_ID) {
telemetrySensor.onlyPositive = 1;
}
else if (id >= ALT_FIRST_ID && id <= ALT_LAST_ID) {
telemetrySensor.autoOffset = 1;
}
if (unit == UNIT_RPMS) {
telemetrySensor.custom.ratio = 1;
telemetrySensor.custom.offset = 1;
}
else if (unit == UNIT_METERS) {
if (IS_IMPERIAL_ENABLE()) {
telemetrySensor.unit = UNIT_FEET;
}
}
else if (unit == UNIT_GPS_LATITUDE || unit == UNIT_GPS_LONGITUDE) {
telemetrySensor.unit = UNIT_GPS;
}
}
else {
telemetrySensor.init(id);
}
storageDirty(EE_MODEL);
}
#if defined(CPUSTM32)
bool sportWaitState(SportUpdateState state, int timeout)
{
#if defined(SIMU)
SIMU_SLEEP_NORET(1);
return true;
#else
for (int i=timeout/2; i>=0; i--) {
uint8_t byte ;
while (telemetryGetByte(&byte)) {
processFrskyTelemetryData(byte);
}
if (sportUpdateState == state) {
return true;
}
else if (sportUpdateState == SPORT_FAIL) {
return false;
}
CoTickDelay(1);
}
return false;
#endif
}
void blankPacket(uint8_t * packet)
{
memset(packet+2, 0, 6);
}
// TODO merge this function
void writePacket(uint8_t * packet)
{
uint8_t * ptr = outputTelemetryBuffer;
*ptr++ = 0x7E;
*ptr++ = 0xFF;
packet[7] = crc16(packet, 7);
for (int i=0; i<8; i++) {
if (packet[i] == 0x7E || packet[i] == 0x7D) {
*ptr++ = 0x7D;
*ptr++ = 0x20 ^ packet[i];
}
else {
*ptr++ = packet[i];
}
}
sportSendBuffer(outputTelemetryBuffer, ptr-outputTelemetryBuffer);
}
bool sportUpdatePowerOn(ModuleIndex module)
{
uint8_t packet[8];
sportUpdateState = SPORT_POWERUP_REQ;
#if defined(PCBTARANIS) || defined(PCBHORUS)
intPwr = IS_INTERNAL_MODULE_ON();
extPwr = IS_EXTERNAL_MODULE_ON();
INTERNAL_MODULE_OFF();
EXTERNAL_MODULE_OFF();
#endif
sportWaitState(SPORT_IDLE, 500);
telemetryPortInit(FRSKY_SPORT_BAUDRATE, TELEMETRY_SERIAL_8N1);
#if defined(PCBTARANIS) || defined(PCBHORUS)
if (module == INTERNAL_MODULE)
INTERNAL_MODULE_ON();
else
EXTERNAL_MODULE_ON();
#endif
sportWaitState(SPORT_IDLE, 50);
for (int i=0; i<10; i++) {
// max 10 attempts
blankPacket(packet);
packet[0] = 0x50 ;
packet[1] = PRIM_REQ_POWERUP;
writePacket(packet);
if (sportWaitState(SPORT_POWERUP_ACK, 100))
return true;
}
return false;
}
bool sportUpdateReqVersion()
{
uint8_t packet[8];
sportWaitState(SPORT_IDLE, 20);
sportUpdateState = SPORT_VERSION_REQ;
for (int i=0; i<10; i++) {
// max 10 attempts
blankPacket(packet) ;
packet[0] = 0x50 ;
packet[1] = PRIM_REQ_VERSION ;
writePacket(packet);
if (sportWaitState(SPORT_VERSION_ACK, 200))
return true;
}
return false;
}
bool sportUpdateUploadFile(const char *filename)
{
FIL file;
uint32_t buffer[1024/4];
UINT count;
uint8_t packet[8];
if (f_open(&file, filename, FA_READ) != FR_OK) {
return false;
}
sportWaitState(SPORT_IDLE, 200);
sportUpdateState = SPORT_DATA_TRANSFER;
blankPacket(packet) ;
packet[0] = 0x50 ;
packet[1] = PRIM_CMD_DOWNLOAD ;
// Stop here for testing
writePacket(packet);
while(1) {
if (f_read(&file, buffer, 1024, &count) != FR_OK) {
f_close(&file);
return false;
}
count >>= 2;
for (UINT i=0; i<count; i++) {
if (!sportWaitState(SPORT_DATA_REQ, 2000)) {
return false;
}
packet[0] = 0x50 ;
packet[1] = PRIM_DATA_WORD ;
packet[6] = sportUpdateAddr & 0x000000FF;
uint32_t offset = ( sportUpdateAddr & 1023 ) >> 2; // 32 bit word offset into buffer
uint32_t *data = (uint32_t *)(&packet[2]);
*data = buffer[offset];
sportUpdateState = SPORT_DATA_TRANSFER,
writePacket(packet);
if (i==0) {
updateProgressBar(file.fptr, file.fsize);
}
}
if (count < 256) {
f_close(&file);
return true;
}
}
}
bool sportUpdateEnd()
{
uint8_t packet[8];
if (!sportWaitState(SPORT_DATA_REQ, 2000))
return false;
blankPacket(packet);
packet[0] = 0x50 ;
packet[1] = PRIM_DATA_EOF;
writePacket(packet);
return sportWaitState(SPORT_COMPLETE, 2000);
}
void sportFirmwareUpdate(ModuleIndex module, const char * filename)
{
bool result = sportUpdatePowerOn(module);
if (result)
result = sportUpdateReqVersion();
if (result)
result = sportUpdateUploadFile(filename);
if (result)
result = sportUpdateEnd();
if (result == false) {
POPUP_WARNING("Firmware Update Error");
}
#if defined(PCBTARANIS) || defined(PCBHORUS)
INTERNAL_MODULE_OFF();
EXTERNAL_MODULE_OFF();
#endif
sportWaitState(SPORT_IDLE, 1000);
#if defined(PCBTARANIS) || defined(PCBHORUS)
if (intPwr)
INTERNAL_MODULE_ON();
if (extPwr)
EXTERNAL_MODULE_ON();
#endif
sportUpdateState = SPORT_IDLE;
}
#endif