/* implement OpenDroneID MAVLink and DroneCAN support */ /* released under GNU GPL v2 or later */ #include "options.h" #include #include "version.h" #include #include #include #include #include "mavlink.h" #include "DroneCAN.h" #include "WiFi_TX.h" #include "BLE_TX.h" #include #include #include "parameters.h" #include "webinterface.h" #include "check_firmware.h" #include #include "efuse.h" #include "led.h" #if AP_DRONECAN_ENABLED static DroneCAN dronecan; #endif #if AP_MAVLINK_ENABLED static MAVLinkSerial mavlink1{Serial1, MAVLINK_COMM_0}; static MAVLinkSerial mavlink2{Serial, MAVLINK_COMM_1}; #endif static WiFi_TX wifi; static BLE_TX ble; #define DEBUG_BAUDRATE 57600 // OpenDroneID output data structure ODID_UAS_Data UAS_data; String status_reason; static uint32_t last_location_ms; static WebInterface webif; #include "soc/soc.h" #include "soc/rtc_cntl_reg.h" static bool arm_check_ok = false; // goes true for LED arm check status static bool pfst_check_ok = false; /* setup serial ports */ void setup() { // disable brownout checking WRITE_PERI_REG(RTC_CNTL_BROWN_OUT_REG, 0); g.init(); led.set_state(Led::LedState::INIT); led.update(); if (g.webserver_enable) { // need WiFi for web server wifi.init(); } // Serial for debug printf Serial.begin(g.baudrate); // Serial1 for MAVLink Serial1.begin(g.baudrate, SERIAL_8N1, PIN_UART_RX, PIN_UART_TX); // set all fields to invalid/initial values odid_initUasData(&UAS_data); #if AP_MAVLINK_ENABLED mavlink1.init(); mavlink2.init(); #endif #if AP_DRONECAN_ENABLED dronecan.init(); #endif set_efuses(); CheckFirmware::check_OTA_running(); #if defined(PIN_CAN_EN) // optional CAN enable pin pinMode(PIN_CAN_EN, OUTPUT); digitalWrite(PIN_CAN_EN, HIGH); #endif #if defined(PIN_CAN_nSILENT) // disable silent pin pinMode(PIN_CAN_nSILENT, OUTPUT); digitalWrite(PIN_CAN_nSILENT, HIGH); #endif #if defined(PIN_CAN_TERM) #if !defined(CAN_TERM_EN) #define CAN_TERM_EN HIGH #endif // optional CAN termination control pinMode(PIN_CAN_TERM, OUTPUT); if (g.can_term == 1) { digitalWrite(PIN_CAN_TERM, CAN_TERM_EN); } else { digitalWrite(PIN_CAN_TERM, !CAN_TERM_EN); } #endif #if defined(BUZZER_PIN) //set BuZZER OUTPUT ACTIVE, just to show it works pinMode(GPIO_NUM_39, OUTPUT); digitalWrite(GPIO_NUM_39, HIGH); #endif pfst_check_ok = true; // note - this will need to be expanded to better capture PFST test status // initially set LED for fail led.set_state(Led::LedState::ARM_FAIL); esp_log_level_set("*", ESP_LOG_DEBUG); esp_ota_mark_app_valid_cancel_rollback(); } #define IMIN(x,y) ((x)<(y)?(x):(y)) #define ODID_COPY_STR(to, from) strncpy(to, (const char*)from, IMIN(sizeof(to), sizeof(from))) /* check parsing of UAS_data, this checks ranges of values to ensure we will produce a valid pack returns nullptr on no error, or a string error */ static const char *check_parse(void) { String ret = ""; { ODID_Location_encoded encoded {}; if (encodeLocationMessage(&encoded, &UAS_data.Location) != ODID_SUCCESS) { ret += "LOC "; } } { ODID_System_encoded encoded {}; if (encodeSystemMessage(&encoded, &UAS_data.System) != ODID_SUCCESS) { ret += "SYS "; } } { ODID_BasicID_encoded encoded {}; if (UAS_data.BasicIDValid[0] == 1) { if (encodeBasicIDMessage(&encoded, &UAS_data.BasicID[0]) != ODID_SUCCESS) { ret += "ID_1 "; } } memset(&encoded, 0, sizeof(encoded)); if (UAS_data.BasicIDValid[1] == 1) { if (encodeBasicIDMessage(&encoded, &UAS_data.BasicID[1]) != ODID_SUCCESS) { ret += "ID_2 "; } } } { ODID_SelfID_encoded encoded {}; if (encodeSelfIDMessage(&encoded, &UAS_data.SelfID) != ODID_SUCCESS) { ret += "SELF_ID "; } } { ODID_OperatorID_encoded encoded {}; if (encodeOperatorIDMessage(&encoded, &UAS_data.OperatorID) != ODID_SUCCESS) { ret += "OP_ID "; } } if (ret.length() > 0) { // if all errors would occur in this function, it will fit in // 50 chars that is also the max for the arm status message static char return_string[50]; memset(return_string, 0, sizeof(return_string)); snprintf(return_string, sizeof(return_string)-1, "bad %s data", ret.c_str()); return return_string; } return nullptr; } /* fill in UAS_data from MAVLink packets */ static void set_data(Transport &t) { const auto &operator_id = t.get_operator_id(); const auto &basic_id = t.get_basic_id(); const auto &system = t.get_system(); const auto &self_id = t.get_self_id(); const auto &location = t.get_location(); odid_initUasData(&UAS_data); /* if we don't have BasicID info from parameters and we have it from the DroneCAN or MAVLink transport then copy it to the parameters to persist it. This makes it possible to set the UAS_ID string via a MAVLink BASIC_ID message and also offers a migration path from the old approach of GCS setting these values to having them as parameters BasicID 2 can be set in parameters, or provided via mavlink We don't persist the BasicID2 if provided via mavlink to allow users to change BasicID2 on different days */ if (!g.have_basic_id_info() && !(g.options & OPTIONS_DONT_SAVE_BASIC_ID_TO_PARAMETERS)) { if (basic_id.ua_type != 0 && basic_id.id_type != 0 && strnlen((const char *)basic_id.uas_id, 20) > 0) { g.set_by_name_uint8("UAS_TYPE", basic_id.ua_type); g.set_by_name_uint8("UAS_ID_TYPE", basic_id.id_type); char uas_id[21] {}; ODID_COPY_STR(uas_id, basic_id.uas_id); g.set_by_name_string("UAS_ID", uas_id); } } // BasicID if (g.have_basic_id_info() && !(g.options & OPTIONS_DONT_SAVE_BASIC_ID_TO_PARAMETERS)) { // from parameters UAS_data.BasicID[0].UAType = (ODID_uatype_t)g.ua_type; UAS_data.BasicID[0].IDType = (ODID_idtype_t)g.id_type; ODID_COPY_STR(UAS_data.BasicID[0].UASID, g.uas_id); UAS_data.BasicIDValid[0] = 1; // BasicID 2 if (g.have_basic_id_2_info()) { // from parameters UAS_data.BasicID[1].UAType = (ODID_uatype_t)g.ua_type_2; UAS_data.BasicID[1].IDType = (ODID_idtype_t)g.id_type_2; ODID_COPY_STR(UAS_data.BasicID[1].UASID, g.uas_id_2); UAS_data.BasicIDValid[1] = 1; } else if (strcmp((const char*)g.uas_id, (const char*)basic_id.uas_id) != 0) { /* no BasicID 2 in the parameters, if one is provided on MAVLink and it is a different uas_id from the basicID1 then use it as BasicID2 */ if (basic_id.ua_type != 0 && basic_id.id_type != 0 && strnlen((const char *)basic_id.uas_id, 20) > 0) { UAS_data.BasicID[1].UAType = (ODID_uatype_t)basic_id.ua_type; UAS_data.BasicID[1].IDType = (ODID_idtype_t)basic_id.id_type; ODID_COPY_STR(UAS_data.BasicID[1].UASID, basic_id.uas_id); UAS_data.BasicIDValid[1] = 1; } } } if (g.options & OPTIONS_DONT_SAVE_BASIC_ID_TO_PARAMETERS) { if (basic_id.ua_type != 0 && basic_id.id_type != 0 && strnlen((const char *)basic_id.uas_id, 20) > 0) { if (strcmp((const char*)UAS_data.BasicID[0].UASID, (const char*)basic_id.uas_id) != 0 && strnlen((const char *)basic_id.uas_id, 20) > 0) { UAS_data.BasicID[1].UAType = (ODID_uatype_t)basic_id.ua_type; UAS_data.BasicID[1].IDType = (ODID_idtype_t)basic_id.id_type; ODID_COPY_STR(UAS_data.BasicID[1].UASID, basic_id.uas_id); UAS_data.BasicIDValid[1] = 1; } else { UAS_data.BasicID[0].UAType = (ODID_uatype_t)basic_id.ua_type; UAS_data.BasicID[0].IDType = (ODID_idtype_t)basic_id.id_type; ODID_COPY_STR(UAS_data.BasicID[0].UASID, basic_id.uas_id); UAS_data.BasicIDValid[0] = 1; } } } // OperatorID if (strlen(operator_id.operator_id) > 0) { UAS_data.OperatorID.OperatorIdType = (ODID_operatorIdType_t)operator_id.operator_id_type; ODID_COPY_STR(UAS_data.OperatorID.OperatorId, operator_id.operator_id); UAS_data.OperatorIDValid = 1; } // SelfID if (strlen(self_id.description) > 0) { UAS_data.SelfID.DescType = (ODID_desctype_t)self_id.description_type; ODID_COPY_STR(UAS_data.SelfID.Desc, self_id.description); UAS_data.SelfIDValid = 1; } // System if (system.timestamp != 0) { UAS_data.System.OperatorLocationType = (ODID_operator_location_type_t)system.operator_location_type; UAS_data.System.ClassificationType = (ODID_classification_type_t)system.classification_type; UAS_data.System.OperatorLatitude = system.operator_latitude * 1.0e-7; UAS_data.System.OperatorLongitude = system.operator_longitude * 1.0e-7; UAS_data.System.AreaCount = system.area_count; UAS_data.System.AreaRadius = system.area_radius; UAS_data.System.AreaCeiling = system.area_ceiling; UAS_data.System.AreaFloor = system.area_floor; UAS_data.System.CategoryEU = (ODID_category_EU_t)system.category_eu; UAS_data.System.ClassEU = (ODID_class_EU_t)system.class_eu; UAS_data.System.OperatorAltitudeGeo = system.operator_altitude_geo; UAS_data.System.Timestamp = system.timestamp; UAS_data.SystemValid = 1; } // Location if (location.timestamp != 0) { UAS_data.Location.Status = (ODID_status_t)location.status; UAS_data.Location.Direction = location.direction*0.01; UAS_data.Location.SpeedHorizontal = location.speed_horizontal*0.01; UAS_data.Location.SpeedVertical = location.speed_vertical*0.01; UAS_data.Location.Latitude = location.latitude*1.0e-7; UAS_data.Location.Longitude = location.longitude*1.0e-7; UAS_data.Location.AltitudeBaro = location.altitude_barometric; UAS_data.Location.AltitudeGeo = location.altitude_geodetic; UAS_data.Location.HeightType = (ODID_Height_reference_t)location.height_reference; UAS_data.Location.Height = location.height; UAS_data.Location.HorizAccuracy = (ODID_Horizontal_accuracy_t)location.horizontal_accuracy; UAS_data.Location.VertAccuracy = (ODID_Vertical_accuracy_t)location.vertical_accuracy; UAS_data.Location.BaroAccuracy = (ODID_Vertical_accuracy_t)location.barometer_accuracy; UAS_data.Location.SpeedAccuracy = (ODID_Speed_accuracy_t)location.speed_accuracy; UAS_data.Location.TSAccuracy = (ODID_Timestamp_accuracy_t)location.timestamp_accuracy; UAS_data.Location.TimeStamp = location.timestamp; UAS_data.LocationValid = 1; } const char *reason = check_parse(); t.arm_status_check(reason); t.set_parse_fail(reason); arm_check_ok = (reason==nullptr); if (g.options & OPTIONS_FORCE_ARM_OK) { arm_check_ok = true; } led.set_state(pfst_check_ok && arm_check_ok? Led::LedState::ARM_OK : Led::LedState::ARM_FAIL); uint32_t now_ms = millis(); uint32_t location_age_ms = now_ms - t.get_last_location_ms(); uint32_t last_location_age_ms = now_ms - last_location_ms; if (location_age_ms < last_location_age_ms) { last_location_ms = t.get_last_location_ms(); } } static uint8_t loop_counter = 0; void loop() { #if AP_MAVLINK_ENABLED mavlink1.update(); mavlink2.update(); #endif #if AP_DRONECAN_ENABLED dronecan.update(); #endif const uint32_t now_ms = millis(); // the transports have common static data, so we can just use the // first for status #if AP_MAVLINK_ENABLED auto &transport = mavlink1; #elif AP_DRONECAN_ENABLED auto &transport = dronecan; #else #error "Must enable DroneCAN or MAVLink" #endif bool have_location = false; const uint32_t last_location_ms = transport.get_last_location_ms(); const uint32_t last_system_ms = transport.get_last_system_ms(); led.update(); status_reason = ""; if (last_location_ms == 0 || now_ms - last_location_ms > 5000) { UAS_data.Location.Status = ODID_STATUS_REMOTE_ID_SYSTEM_FAILURE; } if (last_system_ms == 0 || now_ms - last_system_ms > 5000) { UAS_data.Location.Status = ODID_STATUS_REMOTE_ID_SYSTEM_FAILURE; } if (transport.get_parse_fail() != nullptr) { UAS_data.Location.Status = ODID_STATUS_REMOTE_ID_SYSTEM_FAILURE; status_reason = String(transport.get_parse_fail()); } // web update has to happen after we update Status above if (g.webserver_enable) { webif.update(); } if (g.bcast_powerup) { // if we are broadcasting on powerup we always mark location valid // so the location with default data is sent if (!UAS_data.LocationValid) { UAS_data.Location.Status = ODID_STATUS_REMOTE_ID_SYSTEM_FAILURE; UAS_data.LocationValid = 1; } } else { // only broadcast if we have received a location at least once if (last_location_ms == 0) { delay(1); return; } } set_data(transport); static uint32_t last_update_wifi_nan_ms; if (g.wifi_nan_rate > 0 && now_ms - last_update_wifi_nan_ms > 1000/g.wifi_nan_rate) { last_update_wifi_nan_ms = now_ms; wifi.transmit_nan(UAS_data); } static uint32_t last_update_wifi_beacon_ms; if (g.wifi_beacon_rate > 0 && now_ms - last_update_wifi_beacon_ms > 1000/g.wifi_beacon_rate) { last_update_wifi_beacon_ms = now_ms; wifi.transmit_beacon(UAS_data); } static uint32_t last_update_bt5_ms; if (g.bt5_rate > 0 && now_ms - last_update_bt5_ms > 1000/g.bt5_rate) { last_update_bt5_ms = now_ms; ble.transmit_longrange(UAS_data); } static uint32_t last_update_bt4_ms; int bt4_states = UAS_data.BasicIDValid[1] ? 7 : 6; if (g.bt4_rate > 0 && now_ms - last_update_bt4_ms > (1000.0f/bt4_states)/g.bt4_rate) { last_update_bt4_ms = now_ms; ble.transmit_legacy(UAS_data); } // sleep for a bit for power saving delay(1); }