[vtx] Add VTX driver with Tramp and SmartAudio support

This commit is contained in:
Niklas Hauser
2026-01-26 11:05:22 +01:00
committed by Niklas Hauser
parent fad4450d7d
commit c0c265cd1f
28 changed files with 3397 additions and 1 deletions
+43
View File
@@ -0,0 +1,43 @@
############################################################################
#
# Copyright (c) 2025 PX4 Development Team. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# 3. Neither the name PX4 nor the names of its contributors may be
# used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
############################################################################
px4_add_module(
MODULE drivers__vtx
MAIN vtx
COMPILE_FLAGS
SRCS
VTX.cpp
smart_audio.cpp
tramp.cpp
MODULE_CONFIG
module.yaml
)
+18
View File
@@ -0,0 +1,18 @@
menuconfig DRIVERS_VTX
bool "VTX Driver"
default n
select DRIVERS_VTXTABLE
select VTXTABLE_AUX_MAP
---help---
Control VTX devices via serial interface.
if DRIVERS_VTX
config VTX_CRSF_MSP_SUPPORT
bool "Support using CRSF MSP commands to configure VTX"
depends on DRIVERS_RC_CRSF_RC
default n
---help---
Set VTX frequency and power via CRSF MSP messages.
endif # DRIVERS_VTX
+482
View File
@@ -0,0 +1,482 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#include "VTX.hpp"
#include <fcntl.h>
#include <termios.h>
#include <drivers/drv_hrt.h>
#include "smart_audio.h"
#include "tramp.h"
using namespace time_literals;
VTX::VTX(const char *device) :
ModuleParams(nullptr),
ScheduledWorkItem(MODULE_NAME, px4::serial_port_to_wq(device)),
_perf_cycle(perf_alloc(PC_ELAPSED, MODULE_NAME": cycle time")),
_perf_error(perf_alloc(PC_COUNT, MODULE_NAME": errors")),
_perf_get_settings(perf_alloc(PC_COUNT, MODULE_NAME": errors get settings")),
_perf_set_power(perf_alloc(PC_COUNT, MODULE_NAME": errors set power")),
_perf_set_frequency(perf_alloc(PC_COUNT, MODULE_NAME": errors set frequency")),
_perf_set_pit_mode(perf_alloc(PC_COUNT, MODULE_NAME": errors set pit mode"))
{
if (device) {
strlcpy(_serial_path, device, sizeof(_serial_path));
}
}
VTX::~VTX()
{
delete _protocol;
perf_free(_perf_cycle);
perf_free(_perf_error);
perf_free(_perf_get_settings);
perf_free(_perf_set_power);
perf_free(_perf_set_frequency);
perf_free(_perf_set_pit_mode);
}
int VTX::init()
{
_param_vtx_device.update();
_device = (_param_vtx_device.get() >> 8);
const uint8_t protocol = (_param_vtx_device.get() & 0xff);
if (_protocol == nullptr) {
if (protocol == vtx_s::PROTOCOL_TRAMP) {
_protocol = new vtx::Tramp();
} else {
_protocol = new vtx::SmartAudio();
}
}
if (_protocol == nullptr) {
PX4_ERR("Protocol alloc failed");
return PX4_ERROR;
}
if (_protocol->init(_serial_path) != PX4_OK) {
return PX4_ERROR;
}
return PX4_OK;
}
void VTX::Run()
{
static constexpr auto _INTERVAL{50_ms};
if (should_exit()) {
exit_and_cleanup();
return;
}
perf_begin(_perf_cycle);
switch (_state) {
case STATE_INIT:
if (init() == PX4_OK) {
_state = STATE_UPDATE;
_pending = STATE_SET_ALL;
} else {
perf_count(_perf_error);
}
break;
case STATE_GET_SETTINGS:
if (_protocol->get_settings() == PX4_OK) {
if (!_comms_ok) {
// previous get settings failed, send all settings again
_pending |= STATE_SET_ALL;
}
_pending &= ~STATE_GET_SETTINGS;
_comms_ok = true;
} else {
perf_count(_perf_get_settings);
_comms_ok = false;
}
_update_counter = 1_s / _INTERVAL;
_state = STATE_UPDATE;
break;
case STATE_SET_FREQUENCY:
if ((_frequency ? _protocol->set_frequency(_frequency) : _protocol->set_channel(_band, _channel)) == PX4_OK) {
_pending &= ~STATE_SET_FREQUENCY;
_pending |= STATE_GET_SETTINGS;
} else {
perf_count(_perf_set_frequency);
}
_state = STATE_UPDATE;
break;
case STATE_SET_POWER:
if (_protocol->set_power(_power) == PX4_OK) {
_pending &= ~STATE_SET_POWER;
_pending |= STATE_GET_SETTINGS;
} else {
perf_count(_perf_set_power);
}
_state = STATE_UPDATE;
break;
case STATE_SET_PIT_MODE:
if (_protocol->set_pit_mode(_pit_mode) == PX4_OK) {
_pending &= ~STATE_SET_PIT_MODE;
_pending |= STATE_GET_SETTINGS;
} else {
perf_count(_perf_set_pit_mode);
}
_state = STATE_UPDATE;
break;
default:
// Poll parameters and update settings if needed
int new_band{_band}, new_channel{_channel}, new_frequency{_frequency}, new_power{_power}, new_pit_mode{_pit_mode};
update_params(&new_band, &new_channel, &new_frequency, &new_power, &new_pit_mode);
const vtx::Config::ChangeType current_change = vtxtable().get_change();
if (_last_config_change != current_change) {
_last_config_change = current_change;
_pending |= STATE_SET_ALL;
}
if (_band != new_band || _channel != new_channel) {
_band = new_band;
_channel = new_channel;
_pending |= STATE_SET_FREQUENCY;
}
if (_frequency != new_frequency) {
_frequency = new_frequency;
_pending |= STATE_SET_FREQUENCY;
}
if (_power != new_power) {
_power = new_power;
_pending |= STATE_SET_POWER;
}
if (_pit_mode != new_pit_mode) {
_pit_mode = new_pit_mode;
// Some VTX set power to 0 in pit mode, so also set power again
_pending |= STATE_SET_PIT_MODE | STATE_SET_POWER;
}
if (_update_counter <= 0) {
_pending |= STATE_GET_SETTINGS;
} else {
_update_counter--;
}
// Round robin schedule the next pending flag test
uint8_t current{0};
while (_pending && !current) {
current = uint8_t(_pending & _schedule);
_schedule <<= 1;
if (!(_schedule & STATE_MASK)) {
_schedule = STATE_GET_SETTINGS;
break;
}
}
// Convert pending flags to state
if (current & STATE_GET_SETTINGS) {
_state = STATE_GET_SETTINGS;
} else if (current & STATE_SET_FREQUENCY) {
_state = STATE_SET_FREQUENCY;
} else if (current & STATE_SET_POWER) {
_state = STATE_SET_POWER;
} else if (current & STATE_SET_PIT_MODE) {
_state = STATE_SET_PIT_MODE;
}
handle_uorb();
break;
}
ScheduleDelayed(_INTERVAL);
perf_end(_perf_cycle);
}
void VTX::update_params(int *new_band, int *new_channel, int *new_frequency, int *new_power, int *new_pit_mode)
{
_param_vtx_band.update();
_param_vtx_channel.update();
_param_vtx_power.update();
_param_vtx_frequency.update();
_param_vtx_pit_mode.update();
_param_vtx_map_config.update();
const int map_config = _param_vtx_map_config.get();
// Set transmit channel based on either parameter or manual auxiliary channel input
if (map_config > 1) {
input_rc_s input_rc{};
if (_input_rc_sub.update(&input_rc) && !input_rc.rc_lost) {
int8_t band{0}, channel{0}, power{0};
vtxtable().map_lookup(input_rc.values, input_rc.channel_count, &band, &channel, &power);
if (map_config > 2) {
if (band > 0) { _param_vtx_band.commit_no_notification(band - 1); }
if (channel > 0) { _param_vtx_channel.commit_no_notification(channel - 1); }
}
if (map_config == 2 || map_config == 4) {
if (power == -1) {
_param_vtx_power.commit_no_notification(0);
_param_vtx_pit_mode.commit_no_notification(true);
} else if (power > 0) {
_param_vtx_power.commit_no_notification(power - 1);
_param_vtx_pit_mode.commit_no_notification(false);
}
}
}
}
*new_band = _param_vtx_band.get() % 24;
*new_channel = _param_vtx_channel.get() & 0xF;
*new_power = _param_vtx_power.get() & 0xF;
*new_frequency = _param_vtx_frequency.get();
*new_pit_mode = _param_vtx_pit_mode.get();
}
void VTX::handle_uorb()
{
vtx_s msg{};
msg.band = _band;
msg.channel = _channel;
msg.power_level = _power;
msg.device = _device;
if (!_comms_ok || !_protocol->copy_to(&msg)) {
msg.protocol = vtx_s::PROTOCOL_NONE;
msg.frequency = (_frequency ? _frequency : vtxtable().frequency(_band, _channel));
msg.mode = _pit_mode ? vtx_s::MODE_PIT : vtx_s::MODE_NORMAL;
}
// If frequency is set, overwrite band and channel to -1
if (_frequency) {
msg.band = -1;
msg.channel = -1;
msg.band_letter = 'f';
strncpy((char *)msg.band_name, "FREQUENCY", sizeof(msg.band_name));
} else {
msg.band_letter = vtxtable().band_letter(msg.band);
strncpy((char *)msg.band_name, vtxtable().band_name(msg.band), sizeof(msg.band_name));
}
strncpy((char *)msg.power_label, vtxtable().power_label(msg.power_level), sizeof(msg.power_label));
// Workarounds for specific devices
if (_device == vtx_s::DEVICE_PEAK_THOR_T67) {
// This device always reports pit mode, but still works fine
msg.frequency = vtxtable().frequency(_band, _channel);
msg.mode = _pit_mode ? vtx_s::MODE_PIT : vtx_s::MODE_NORMAL;
}
// Only publish if something changed
if (memcmp(&msg, &_vtx_msg, sizeof(msg)) != 0) {
_vtx_msg = msg;
msg.timestamp = hrt_absolute_time();
_vtx_pub.publish(msg);
}
}
int VTX::custom_command(int argc, char *argv[])
{
if (!strcmp(argv[0], "start")) {
if (is_running()) {
return print_usage("already running");
}
int ret = VTX::task_spawn(argc, argv);
if (ret) {
return ret;
}
}
if (!is_running()) {
return print_usage("not running");
}
// Check if the first argument is a number and delegate to the VtxTable
char *endptr{};
strtol(argv[0], &endptr, 10);
if (endptr != argv[0]) {
extern int vtxtable_custom_command(int argc, char *argv[]);
return vtxtable_custom_command(argc, argv);
}
return print_usage("unknown command");
}
int VTX::task_spawn(int argc, char *argv[])
{
int myoptind = 1;
int ch;
const char *myoptarg = nullptr;
const char *device_name = nullptr;
while ((ch = px4_getopt(argc, argv, "d:", &myoptind, &myoptarg)) != EOF) {
switch (ch) {
case 'd':
device_name = myoptarg;
break;
default:
PX4_WARN("unrecognized flag");
return -1;
break;
}
}
if (device_name && (access(device_name, R_OK | W_OK) == 0)) {
auto *const instance = new VTX(device_name);
if (instance == nullptr) {
PX4_ERR("alloc failed");
return PX4_ERROR;
}
_object.store(instance);
_task_id = task_id_is_work_queue;
instance->ScheduleNow();
return PX4_OK;
} else {
if (device_name) {
PX4_ERR("invalid device (-d) %s", device_name);
} else {
PX4_INFO("valid device required");
}
}
return PX4_ERROR;
}
int VTX::print_status()
{
if (_serial_path[0]) {
PX4_INFO("UART device: %s", _serial_path);
}
#ifdef CONFIG_VTX_CRSF_MSP_SUPPORT
const char *const config_map[] {"Disabled", "MSP", "MSP=Band/Channel, AUX=Power", "MSP=Power, AUX=Band/Channel", "AUX"};
#else
const char *const config_map[] {"Disabled", "Disabled", "Power", "Band/Channel", "Power/Band/Channel"};
#endif
const char *const config_str = config_map[_param_vtx_map_config.get() <= 4 ? _param_vtx_map_config.get() : 0];
PX4_INFO("RC mapping: %s", config_str);
PX4_INFO("Parameters:");
PX4_INFO(" band: %d", (_frequency ? -1 : (_band + 1)));
PX4_INFO(" channel: %d", (_frequency ? -1 : (_channel + 1)));
PX4_INFO(" frequency: %u MHz", (_frequency ? _frequency : vtxtable().frequency(_band, _channel)));
PX4_INFO(" power level: %u", _power + 1);
PX4_INFO(" power: %hi = %s", vtxtable().power_value(_power), vtxtable().power_label(_power));
PX4_INFO(" pit mode: %s", _pit_mode ? "on" : "off");
if (!(_comms_ok && _protocol && _protocol->print_settings())) {
PX4_ERR("%s device not found", _param_vtx_device.get() == 1 ? "Tramp" : "SmartAudio");
}
perf_print_counter(_perf_cycle);
perf_print_counter(_perf_error);
perf_print_counter(_perf_get_settings);
perf_print_counter(_perf_set_power);
perf_print_counter(_perf_set_frequency);
perf_print_counter(_perf_set_pit_mode);
return 0;
}
int VTX::print_usage(const char *reason)
{
if (reason) {
PX4_WARN("%s\n", reason);
}
PRINT_MODULE_DESCRIPTION(
R"DESCR_STR(
### Description
This module communicates with a VTX camera via serial port. It can be used to
configure the camera settings and to control the camera's video transmission.
Supported protocols are:
- SmartAudio v1, v2.0, v2.1
- Tramp
)DESCR_STR");
PRINT_MODULE_USAGE_NAME("vtx", "driver");
PRINT_MODULE_USAGE_COMMAND("start");
PRINT_MODULE_USAGE_PARAM_STRING('d', nullptr, "<file:dev>", "VTX device", false);
PRINT_MODULE_USAGE_COMMAND_DESCR("<int>", "Sets an entry in the mapping table: <index> <aux channel> <band> <channel> <power level> <start range> <end range>");
PRINT_MODULE_USAGE_DEFAULT_COMMANDS();
return 0;
}
extern "C" __EXPORT int vtx_main(int argc, char *argv[])
{
return VTX::main(argc, argv);
}
+134
View File
@@ -0,0 +1,134 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#pragma once
#include <float.h>
#include <board_config.h>
#include <drivers/drv_hrt.h>
#include <lib/perf/perf_counter.h>
#include <px4_platform_common/Serial.hpp>
#include <px4_platform_common/px4_config.h>
#include <px4_platform_common/getopt.h>
#include <px4_platform_common/log.h>
#include <px4_platform_common/module.h>
#include <px4_platform_common/module_params.h>
#include <px4_platform_common/px4_work_queue/ScheduledWorkItem.hpp>
#include <uORB/PublicationMulti.hpp>
#include <uORB/Subscription.hpp>
#include <uORB/topics/vtx.h>
#include <uORB/topics/input_rc.h>
#include "protocol.h"
#include "../vtxtable/VtxTable.hpp"
/**
* @author Niklas Hauser <niklas@auterion.com>
*/
class VTX : public ModuleBase<VTX>, public ModuleParams, public px4::ScheduledWorkItem
{
public:
VTX(const char *device);
virtual ~VTX();
/** @see ModuleBase */
static int task_spawn(int argc, char *argv[]);
/** @see ModuleBase */
static int custom_command(int argc, char *argv[]);
/** @see ModuleBase */
static int print_usage(const char *reason = nullptr);
/** @see ModuleBase::print_status() */
int print_status() override;
int init();
private:
void Run() override;
void update_params(int *new_band, int *new_channel, int *new_frequency, int *new_power, int *new_pit_mode);
void handle_uorb();
char _serial_path[20] {};
vtx::Protocol *_protocol{nullptr};
DEFINE_PARAMETERS(
(ParamInt<px4::params::VTX_BAND>) _param_vtx_band,
(ParamInt<px4::params::VTX_CHANNEL>) _param_vtx_channel,
(ParamInt<px4::params::VTX_FREQUENCY>) _param_vtx_frequency,
(ParamInt<px4::params::VTX_POWER>) _param_vtx_power,
(ParamBool<px4::params::VTX_PIT_MODE>) _param_vtx_pit_mode,
(ParamInt<px4::params::VTX_MAP_CONFIG>) _param_vtx_map_config,
(ParamInt<px4::params::VTX_DEVICE>) _param_vtx_device
);
perf_counter_t _perf_cycle;
perf_counter_t _perf_error;
perf_counter_t _perf_get_settings;
perf_counter_t _perf_set_power;
perf_counter_t _perf_set_frequency;
perf_counter_t _perf_set_pit_mode;
uORB::PublicationMulti<vtx_s> _vtx_pub{ORB_ID(vtx)};
uORB::Subscription _input_rc_sub{ORB_ID(input_rc)};
vtx_s _vtx_msg{};
int8_t _band{0};
int8_t _channel{0};
int16_t _frequency{0};
int16_t _power{0};
uint8_t _device{0};
bool _pit_mode{};
enum : uint8_t {
STATE_INIT = 0,
STATE_GET_SETTINGS = 0b0001,
STATE_SET_PIT_MODE = 0b0010,
STATE_SET_FREQUENCY = 0b0100,
STATE_SET_POWER = 0b1000,
STATE_UPDATE = 0b1'0000,
STATE_SET_ALL = STATE_SET_FREQUENCY | STATE_SET_POWER | STATE_SET_PIT_MODE,
STATE_MASK = 0b1111,
} _state{STATE_INIT};
uint8_t _pending{};
uint8_t _schedule{STATE_GET_SETTINGS};
int8_t _update_counter{};
bool _comms_ok{};
vtx::Config::ChangeType _last_config_change{};
};
+133
View File
@@ -0,0 +1,133 @@
module_name: VTX SmartAudio
serial_config:
- command: vtx start -d ${SERIAL_DEV}
port_config_param:
name: VTX_SER_CFG
group: VTX
label: VTX Serial Port
parameters:
- group: VTX
definitions:
VTX_BAND:
description:
short: VTX band
long: VTX table band 1-24
type: enum
values:
0: Band 1
1: Band 2
2: Band 3
3: Band 4
4: Band 5
5: Band 6
6: Band 7
7: Band 8
8: Band 9
9: Band 10
10: Band 11
11: Band 12
12: Band 13
13: Band 14
14: Band 15
15: Band 16
16: Band 17
17: Band 18
18: Band 19
19: Band 20
20: Band 21
21: Band 22
22: Band 23
23: Band 24
default: 0
VTX_CHANNEL:
description:
short: VTX channel
long: VTX table channel 1-16
type: enum
values:
0: Channel 1
1: Channel 2
2: Channel 3
3: Channel 4
4: Channel 5
5: Channel 6
6: Channel 7
7: Channel 8
8: Channel 9
9: Channel 10
10: Channel 11
11: Channel 12
12: Channel 13
13: Channel 14
14: Channel 15
15: Channel 16
default: 0
VTX_FREQUENCY:
description:
short: VTX frequency in MHz
long: |
If the VTX frequency is set, it will overwrite the band and channel
settings. Set to 0 to use band and channel settings.
type: int32
min: 0
max: 32000
default: 0
VTX_POWER:
description:
short: VTX power level
long: VTX transmission power level 1-16
type: enum
values:
0: Level 1
1: Level 2
2: Level 3
3: Level 4
4: Level 5
5: Level 6
6: Level 7
7: Level 8
8: Level 9
9: Level 10
10: Level 11
11: Level 12
12: Level 13
13: Level 14
14: Level 15
15: Level 16
default: 0
VTX_PIT_MODE:
description:
short: VTX pit mode
long: VTX pit mode reduces power to the minimum
type: boolean
default: false
VTX_MAP_CONFIG:
description:
short: VTX mapping configuration
long: |
Configure how VTX settings are controlled. Options include using
MSP commands, AUX channels or a combination of both. To use MSP
commands, you must use a CRSF receiver with MSP support enabled in
the PX4 build.
type: enum
values:
0: Disabled
1: MSP for Power, Band and Channel
2: MSP for Band and Channel, AUX for Power
3: MSP for Power, AUX for Band and Channel
4: AUX for Power, Band and Channel
default: 0
VTX_DEVICE:
description:
short: VTX device
long: Specific VTX device useful for workarounds and optimizations
type: enum
# Note: keep values in sync with msg/Vtx.msg: lower 8-bit is protocol, next 8-bit is device
values:
0: SmartAudio v1, v2, v2.1 Protocol
100: Tramp Protocol
5120: Peak THOR T67
10240: Rush MAX SOLO
default: 0
reboot_required: true
+185
View File
@@ -0,0 +1,185 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#pragma once
#include <board_config.h>
#include <px4_platform_common/Serial.hpp>
#include <px4_platform_common/log.h>
#include <uORB/topics/vtx.h>
#include "../vtxtable/VtxTable.hpp"
namespace vtx
{
/**
* Parser class for working with Tramp protocol.
* @author Niklas Hauser <niklas@auterion.com>
*/
class Protocol
{
public:
/// @brief Constructor
/// @param baudrate The baud rate for the serial connection
constexpr Protocol(uint16_t baudrate) :
_baudrate(baudrate)
{}
virtual inline ~Protocol()
{
if (_serial) {
_serial->close();
delete _serial;
}
}
inline int init(const char *device)
{
if (_serial == nullptr) {
_serial = new device::Serial(device, _baudrate);
} else {
_serial->close();
}
if (_serial == nullptr) {
PX4_ERR("Serial alloc failed");
return PX4_ERROR;
}
#ifdef CONFIG_BOARD_SERIAL_RC
// All RC serial ports are RX by default, so we need to swap RX and TX
// to get the TX pin on the RX pin.
if (strcmp(device, CONFIG_BOARD_SERIAL_RC) == 0 && !board_rc_swap_rxtx(device)) {
_serial->setSwapRxTxMode();
}
#endif
_serial->setStopbits(device::SerialConfig::StopBits::Two);
_serial->setSingleWireMode();
if (!_serial->open()) {
PX4_ERR("Serial open failed");
delete _serial;
_serial = nullptr;
return PX4_ERROR;
}
if (reset() != 0) {
return PX4_ERROR;
}
return PX4_OK;
}
/// @brief Reset the VTX
/// @return 0 on success, negative error code on failure
virtual int reset() { return 0; }
/// @brief Get the current settings from the VTX
/// @return 0 on success, negative error code on failure
virtual int get_settings() = 0;
/// @brief Set the power
/// @param power_level The power level to set, negative values set dBm or mW depending on the implementation
/// @return 0 on success, negative error code on failure
virtual int set_power(int16_t power_level) = 0;
/// @brief Set the frequency
/// @param frequency_MHz The frequency to set, negative values set pit frequency
/// @return 0 on success, negative error code on failure
virtual int set_frequency(int16_t frequency_MHz) = 0;
/// @brief Set the frequency based on band and channel
/// @param band The band (0-7)
/// @param channel The channel (0-7)
/// @return 0 on success, negative error code on failure
virtual int set_channel(uint8_t band, uint8_t channel)
{
return set_frequency(vtxtable().frequency(band, channel));
}
/// @brief Set the pit mode
/// @param onoff true to enable pit mode, false to disable
/// @return 0 on success, negative error code on failure
virtual int set_pit_mode(bool onoff) = 0;
/// @brief Print the current settings
/// @return true if device is connected and settings are valid
virtual bool print_settings() = 0;
/// @brief Copy the current settings to a uORB message
/// @param msg The message to copy the settings to
/// @return true if data is valid and has been copied
virtual bool copy_to(vtx_s *msg) = 0;
protected:
/// @brief Parse incoming bytes
/// @param value The incoming byte
/// @return Number of remaining bytes to read, 0 if a full message has been received, negative on error
virtual int rx_parser(uint8_t value) = 0;
inline int rx_msg()
{
using namespace time_literals;
memset(_rx_buf, 0, sizeof(_rx_buf));
_read_state = 0;
const hrt_abstime start_time_us = hrt_absolute_time();
int remaining{3};
while (true) {
const int new_bytes = _serial->readAtLeast(_serial_buf, sizeof(_serial_buf), remaining, 20);
for (int i = 0; i < new_bytes; i++) {
remaining = rx_parser(_serial_buf[i]);
if (remaining <= 0) { return remaining; }
}
if (hrt_elapsed_time(&start_time_us) > 200_ms) {
return -ETIMEDOUT;
}
}
return -1;
}
const uint16_t _baudrate{};
device::Serial *_serial{};
uint8_t _tx_buf[32] {};
uint8_t _rx_buf[32] {};
uint8_t _serial_buf[32] {};
uint8_t _read_state{};
};
} // namespace vtx
+368
View File
@@ -0,0 +1,368 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#include "smart_audio.h"
#include <string.h>
#include <cerrno>
#include <drivers/drv_hrt.h>
#include <px4_platform_common/log.h>
#include <math.h>
namespace vtx
{
using namespace time_literals;
int SmartAudio::get_settings()
{
const uint8_t buf[] = {COMMAND_GET_SETTINGS, 0};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
Settings s;
memcpy(&s, _rx_buf + 2, sizeof(Settings));
// Fix frequency endianess
s.frequency = __builtin_bswap16(s.frequency);
const uint8_t version = _rx_buf[0] >> 3;
if (version == 0) { // v1
s.number_of_power_levels = 4;
s.power_levels[0] = 7;
s.power_levels[1] = 16;
s.power_levels[2] = 25;
s.power_levels[3] = 40;
} else if (version == 1) { // v2
s.number_of_power_levels = 8;
} else if (version == 2) { // v2.1
if (s.number_of_power_levels > 7) {
s.number_of_power_levels = 7;
}
for (int i = 0; i < s.number_of_power_levels; i++) {
s.power_levels[i] = s.power_levels[i + 1];
}
}
s.version = version;
// copy the settings to storage
_settings = s;
return PX4_OK;
}
bool SmartAudio::print_settings()
{
if (_settings.version > 2) { return false; }
PX4_INFO("SmartAudio v%s%s:", ((const char *[]) {"1", "2", "2.1"})[_settings.version],
(_settings.mode & SmartAudio::MODE_SET_FREQUENCY) ? "+fr" : "+ch");
PX4_INFO(" band: %u", ((_settings.channel >> 3) & 0b111) + 1);
PX4_INFO(" channel: %u", (_settings.channel & 0b111) + 1);
PX4_INFO(" frequency: %u MHz", _settings.frequency);
PX4_INFO(" power level: %u", _settings.current_power_level + 1);
const char *power_label = vtxtable().power_label(_settings.current_power_level);
if (_settings.version == 2) {
PX4_INFO(" power: %u dBm = %s", _settings.current_power_dBm, power_label);
} else {
PX4_INFO(" power: %s", power_label);
}
PX4_INFO(" pit mode: %s", (_settings.mode & (SmartAudio::MODE_IN_RANGE_PIT_MODE |
SmartAudio::MODE_OUT_RANGE_PIT_MODE)) ? "on" : "off");
PX4_INFO(" lock: %slocked", (_settings.mode & SmartAudio::MODE_UNLOCKED) ? "un" : "");
return true;
}
bool SmartAudio::copy_to(vtx_s *msg)
{
if (_settings.version > 2) { return false; }
if (_settings.version == 0) { msg->protocol = vtx_s::PROTOCOL_SMART_AUDIO_V1; }
else if (_settings.version == 1) { msg->protocol = vtx_s::PROTOCOL_SMART_AUDIO_V2; }
else { msg->protocol = vtx_s::PROTOCOL_SMART_AUDIO_V2_1; }
msg->band = _settings.channel >> 3;
msg->channel = _settings.channel & 0b111;
msg->frequency = _settings.frequency;
msg->power_level = _settings.current_power_level;
bool pm = (_settings.mode & (SmartAudio::MODE_IN_RANGE_PIT_MODE | SmartAudio::MODE_OUT_RANGE_PIT_MODE));
msg->mode = pm ? vtx_s::MODE_PIT : vtx_s::MODE_NORMAL;
return true;
}
int SmartAudio::set_power(uint8_t power_level, bool is_dBm)
{
if (power_level >= _settings.number_of_power_levels) {
return PX4_ERROR;
}
power_level = vtxtable().power_value(power_level);
if (_settings.version == 2 && is_dBm) { power_level |= 0x80; }
const uint8_t buf[] = {COMMAND_SET_POWER, 1, power_level};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
return ((_rx_buf[0] == COMMAND_SET_POWER) && (_rx_buf[2] == (power_level & ~0x80))) ? PX4_OK : PX4_ERROR;
}
int SmartAudio::set_channel(uint8_t band, uint8_t channel)
{
if (vtxtable().band_attribute(band) == Config::BandAttribute::CUSTOM) {
const uint16_t freq = vtxtable().frequency(band, channel);
if (freq) { return set_frequency(freq, false); }
}
const uint8_t value = ((band & 0b111) << 3) | (channel & 0b111);
const uint8_t buf[] = {COMMAND_SET_CHANNEL, 1, value};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
return ((_rx_buf[0] == COMMAND_SET_CHANNEL) && (_rx_buf[2] == value)) ? PX4_OK : PX4_ERROR;
}
int SmartAudio::set_frequency(uint16_t frequency, bool pit)
{
pit ? frequency |= 0x8000 : frequency &= ~0x8000;
const uint8_t buf[] = {COMMAND_SET_FREQUENCY, 2, uint8_t(frequency >> 8), uint8_t(frequency)};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
const bool success = (_rx_buf[0] == COMMAND_SET_FREQUENCY) && (_rx_buf[2] == (frequency >> 8));
if (_settings.version == 2) {
return (success && (_rx_buf[3] == (frequency & 0xff))) ? PX4_OK : PX4_ERROR;
} else {
// Some v1/v2 firmwares do not echo the low byte back
// But the CRC is still correct, so we assume success
return success ? PX4_OK : PX4_ERROR;
}
}
int SmartAudio::set_operating_mode(uint8_t mode)
{
if (_settings.version == 0) {
return -1;
}
const uint8_t buf[] = {COMMAND_SET_MODE, 1, mode};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
return ((_rx_buf[0] == COMMAND_SET_MODE) && (_rx_buf[2] == mode)) ? PX4_OK : PX4_ERROR;
}
int SmartAudio::set_pit_mode(bool onoff)
{
// only v2 supports pit mode
if (_settings.version == 0) {
return 0;
}
uint8_t mode{SET_MODE_UNLOCKED};
if (onoff) {
if (_settings.mode & MODE_OUT_RANGE_PIT_MODE) {
mode |= SET_MODE_OUT_RANGE;
} else {
mode |= SET_MODE_IN_RANGE;
}
} else {
mode |= SET_MODE_DISABLE_PIT_MODE;
}
return set_operating_mode(mode);
}
int SmartAudio::transmit(const uint8_t *buf, size_t len)
{
if (len > 28) { return -1; }
// copy the message data
memcpy(_tx_buf + 3, buf, len);
// shift the command to the left
// const uint8_t cmd = buf[0];
_tx_buf[3] = (buf[0] << 1) | 0x01;
// compute the CRC
_tx_buf[3 + len] = crc8(_tx_buf + 1, 2 + len);
// some devices need an additional 0 byte at the end
_tx_buf[4 + len] = 0;
// send command
if (_serial->write(_tx_buf, 5 + len) < ssize_t(5 + len)) {
return -errno;
}
_serial->flush();
return rx_msg();
}
bool SmartAudio::is_rsp(uint8_t cmd, uint8_t length)
{
if (length == 0) { return false; }
if (cmd == COMMAND_SET_POWER && length == 0x03) { return true; }
if (cmd == COMMAND_SET_CHANNEL && length == 0x03) { return true; }
if (cmd == COMMAND_SET_FREQUENCY && length == 0x04) { return true; }
if (cmd == COMMAND_SET_MODE && length == 0x03) { return true; }
if (((cmd == COMMAND_GET_SETTINGS) || (cmd == COMMAND_GET_SETTINGS_V2) ||
(cmd == COMMAND_GET_SETTINGS_V21)) && length >= 0x06) { return true; }
return false;
}
int SmartAudio::rx_parser(uint8_t c)
{
enum {
SYNC1 = 0,
SYNC2 = 1,
COMMAND = 2,
LENGTH = 3,
DATA = 4,
CRC = 5,
};
switch (_read_state) {
case SYNC1:
PX4_DEBUG("SYNC1 %x", c);
if (c == 0xAA) {
_read_state = SYNC2;
}
return 1;
case SYNC2:
PX4_DEBUG("SYNC2 %x", c);
if (c == 0x55) {
_read_state = COMMAND;
return 3;
} else {
_read_state = SYNC1;
return 1;
}
case COMMAND:
PX4_DEBUG("COMMAND %x", c);
_rx_buf[0] = c;
_read_state = LENGTH;
return 2;
case LENGTH:
PX4_DEBUG("LENGTH %x", c);
if (c >= 20) {
_read_state = SYNC1;
return 1;
}
_rx_buf[1] = c;
// command response: has one length too many
if (is_rsp(_rx_buf[0], c) && c) { c--; }
_read_length = c;
_read_data_length = 0;
_read_state = _read_length ? DATA : CRC;
return _read_length + 1;
case DATA:
PX4_DEBUG("DATA %x", c);
_rx_buf[2 + _read_data_length] = c;
if (++_read_data_length >= _read_length) {
_read_state = CRC;
}
return _read_length - _read_data_length + 1;
case CRC:
PX4_DEBUG("CRC %x", c);
_read_state = SYNC1;
if (!is_rsp(_rx_buf[0], _rx_buf[1])) { return 1; }
return (c == crc8(_rx_buf, 2u + _read_length)) ? 0 : -CRC;
}
return -6000;
}
uint8_t SmartAudio::crc8(const uint8_t *data, const uint8_t len)
{
// Implementation adapted from lib/crc/crc.c
uint8_t crc{};
const uint8_t poly{0xd5};
for (uint8_t i = 0 ; i < len; i++) {
crc ^= data[i];
for (uint8_t j = 0; j < 8; j++) {
if (crc & (1u << 7u)) {
crc = (uint8_t)((crc << 1u) ^ poly);
} else {
crc = (uint8_t)(crc << 1u);
}
}
}
return crc;
}
}
+129
View File
@@ -0,0 +1,129 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#pragma once
#include "protocol.h"
namespace vtx
{
/**
* Implementation for working with SmartAudio protocol.
* @author Niklas Hauser <niklas@auterion.com>
*/
class SmartAudio final : public Protocol
{
public:
static constexpr int BAUDRATE{4800};
struct Settings {
uint8_t channel;
uint8_t current_power_level;
uint8_t mode;
uint16_t frequency;
uint8_t current_power_dBm;
uint8_t number_of_power_levels;
uint8_t power_levels[8];
uint8_t version;
} __attribute__((packed));
enum {
MODE_SET_FREQUENCY = 0b0001,
MODE_PIT_MODE_ACTIVE = 0b0010,
MODE_IN_RANGE_PIT_MODE = 0b0100,
MODE_OUT_RANGE_PIT_MODE = 0b1000,
MODE_UNLOCKED = 0b10000,
};
const Settings &settings() const { return _settings; }
inline SmartAudio() : Protocol(BAUDRATE)
{
_tx_buf[1] = 0xAA;
_tx_buf[2] = 0x55;
}
virtual ~SmartAudio() = default;
inline int set_power(int16_t power_level) override
{
// negative values do not force dBm mode
if (power_level < 0) { return set_power(-power_level, false); }
return set_power(power_level, true);
}
inline int set_frequency(int16_t frequency_MHz) override
{
if (frequency_MHz < 0) { return set_frequency(-frequency_MHz, true); }
return set_frequency(frequency_MHz, false);
}
int set_channel(uint8_t band, uint8_t channel) override;
int get_settings() override;
int set_pit_mode(bool onoff) override;
bool print_settings() override;
bool copy_to(vtx_s *msg) override;
// Additional methods not part of the Protocol interface
int set_frequency(uint16_t frequency_MHz, bool pit = false);
int set_power(uint8_t power_level, bool is_dBm = true);
int set_operating_mode(uint8_t mode);
private:
int rx_parser(uint8_t c) override;
int transmit(const uint8_t *buf, size_t len);
static uint8_t crc8(const uint8_t *data, uint8_t len);
static bool is_rsp(uint8_t cmd, uint8_t length);
enum {
COMMAND_GET_SETTINGS = 0x01,
COMMAND_SET_POWER = 0x02,
COMMAND_SET_CHANNEL = 0x03,
COMMAND_SET_FREQUENCY = 0x04,
COMMAND_SET_MODE = 0x05,
COMMAND_GET_SETTINGS_V2 = 0x09,
COMMAND_GET_SETTINGS_V21 = 0x11,
};
enum {
SET_MODE_IN_RANGE = 0b0001,
SET_MODE_OUT_RANGE = 0b0010,
SET_MODE_DISABLE_PIT_MODE = 0b0100,
SET_MODE_UNLOCKED = 0b1000,
};
Settings _settings{.version = 99};
uint8_t _read_length{};
uint8_t _read_data_length{};
};
}
+294
View File
@@ -0,0 +1,294 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#include "tramp.h"
#include <string.h>
#include <cerrno>
#include <drivers/drv_hrt.h>
#include <px4_platform_common/log.h>
#include <math.h>
namespace vtx
{
using namespace time_literals;
int Tramp::get_settings()
{
const int rv = get_status();
if (rv != 0) { return rv; }
px4_usleep(30_ms);
return get_temperature();
}
bool Tramp::print_settings()
{
PX4_INFO("Tramp:");
PX4_INFO(" frequency: %hu MHz", _settings.frequency);
PX4_INFO(" requested power: %hu mW", _settings.requested_power_mW);
PX4_INFO(" power: %hu mW", _settings.power_mW);
PX4_INFO(" pit mode: %s", _settings.pit_mode ? "on" : "off");
PX4_INFO(" temperature: %hi C", _settings.temperature);
PX4_INFO(" min frequency: %hu MHz", _settings.min_frequency);
PX4_INFO(" max frequency: %hu MHz", _settings.max_frequency);
PX4_INFO(" max power: %hu mW", _settings.max_power_mW);
return true;
}
bool Tramp::copy_to(vtx_s *msg)
{
msg->protocol = vtx_s::PROTOCOL_TRAMP;
msg->frequency = _settings.frequency;
msg->power_level = _requested_power_level;
msg->mode = _settings.pit_mode ? vtx_s::MODE_PIT : vtx_s::MODE_NORMAL;
return true;
}
int Tramp::get_status()
{
const uint8_t buf[] = {COMMAND_GET_SETTINGS};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
_settings.frequency = (_rx_buf[2] | (_rx_buf[3] << 8));
_settings.requested_power_mW = (_rx_buf[4] | (_rx_buf[5] << 8));
_settings.control_mode = _rx_buf[6];
_settings.pit_mode = _rx_buf[7];
_settings.power_mW = (_rx_buf[8] | (_rx_buf[9] << 8));
return PX4_OK;
}
int Tramp::get_temperature()
{
const uint8_t buf[] = {COMMAND_GET_TEMPERATURE};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
_settings.temperature = int16_t(_rx_buf[6] | (_rx_buf[7] << 8));
return PX4_OK;
}
int Tramp::reset()
{
const uint8_t buf[] = {COMMAND_RESET};
const int rv = transmit(buf, sizeof(buf));
if (rv != 0) { return rv; }
_settings.min_frequency = int16_t(_rx_buf[2] | (_rx_buf[3] << 8));
_settings.max_frequency = int16_t(_rx_buf[4] | (_rx_buf[5] << 8));
_settings.max_power_mW = int16_t(_rx_buf[6] | (_rx_buf[7] << 8));
return PX4_OK;
}
int Tramp::set_power(int16_t power_level)
{
int16_t power_mW;
_requested_power_level = -1;
if (power_level < 0) {
power_mW = -power_level;
} else {
power_mW = vtxtable().power_value(power_level);
if (power_mW == 0) { return -EINVAL; }
_requested_power_level = power_level;
}
const uint8_t buf[] = {COMMAND_SET_POWER, uint8_t(power_mW), uint8_t(power_mW >> 8)};
int rv = transmit(buf, sizeof(buf));
if (rv) { return rv; }
px4_usleep(30_ms);
rv = get_status();
if (rv) { return rv; }
return (_settings.requested_power_mW == power_mW) ? PX4_OK : PX4_ERROR;
}
int Tramp::set_frequency(int16_t frequency_MHz)
{
if (frequency_MHz < 0) { return -EINVAL; } // Tramp does not support pit frequency setting
const uint8_t buf[] = {COMMAND_SET_FREQUENCY, uint8_t(frequency_MHz), uint8_t(frequency_MHz >> 8)};
int rv = transmit(buf, sizeof(buf));
if (rv) { return rv; }
px4_usleep(30_ms);
rv = get_status();
if (rv) { return rv; }
return (_settings.frequency == frequency_MHz) ? PX4_OK : PX4_ERROR;
}
int Tramp::set_pit_mode(bool onoff)
{
const uint8_t mode = onoff ? 0u : 1u;
const uint8_t buf[] = {COMMAND_SET_MODE, mode};
int rv = transmit(buf, sizeof(buf));
if (rv) { return rv; }
px4_usleep(30_ms);
rv = get_status();
if (rv) { return rv; }
return (_settings.pit_mode == onoff ? 1u : 0u) ? PX4_OK : PX4_ERROR;
}
int Tramp::transmit(const uint8_t *buf, size_t len)
{
if (len > 28) { return -1; }
memset(_tx_buf + 1, 0, sizeof(_tx_buf) - 1);
// copy the message data
memcpy(_tx_buf + 1, buf, len);
// compute the CRC
_tx_buf[offsetof(Frame, crc)] = crc8(_tx_buf);
// send command
if (_serial->write(_tx_buf, sizeof(Frame)) < ssize_t(sizeof(Frame))) {
return -errno;
}
_serial->flush();
return rx_msg();
}
int Tramp::rx_parser(uint8_t c)
{
enum {
SYNC = 0,
COMMAND = 1,
DATA = 2,
CRC = 3,
END = 4,
};
static constexpr uint8_t CRCPOS{offsetof(Frame, crc)};
switch (_read_state) {
case SYNC:
PX4_DEBUG("SYNC %x", c);
if (c == 0x0F) {
_rx_buf[0] = c;
_read_state = COMMAND;
return 1;
} else {
_read_state = SYNC;
return 1;
}
case COMMAND:
PX4_DEBUG("COMMAND %x", c);
switch (c) {
case COMMAND_RESET:
case COMMAND_GET_TEMPERATURE:
case COMMAND_GET_SETTINGS:
case COMMAND_SET_POWER:
case COMMAND_SET_FREQUENCY:
case COMMAND_SET_MODE:
_rx_buf[1] = c;
_read_state = DATA;
_read_data_length = 2;
return CRCPOS;
}
_read_state = SYNC;
return 1;
case DATA:
PX4_DEBUG("DATA %x", c);
_rx_buf[_read_data_length] = c;
if (++_read_data_length >= CRCPOS) {
_read_state = CRC;
}
return sizeof(Frame) - _read_data_length;
case CRC:
PX4_DEBUG("CRC %x", c);
_read_state = END;
_rx_buf[CRCPOS] = c;
return 1;
case END:
PX4_DEBUG("END %x", c);
_read_state = SYNC;
// small letter commands with empty payloads were sent by us
if ((_rx_buf[1] & 0x20) && !_rx_buf[2] && !_rx_buf[3]) { return 1; }
// large letter command do not get a response
// Check the CRC for the received data
return (_rx_buf[CRCPOS] == crc8(_rx_buf)) ? 0 : -CRC;
}
return -6000;
}
uint8_t Tramp::crc8(const uint8_t *data)
{
uint8_t crc{0};
for (uint_fast8_t ii{1}; ii < offsetof(Frame, crc); ii++) {
crc += data[ii];
}
return crc;
}
}
+112
View File
@@ -0,0 +1,112 @@
/****************************************************************************
*
* Copyright (c) 2025 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#pragma once
#include "protocol.h"
namespace vtx
{
/**
* Implementation for working with Tramp protocol.
* @author Niklas Hauser <niklas@auterion.com>
*/
class Tramp final : public Protocol
{
public:
static constexpr int BAUDRATE{9600};
struct Settings {
// command 'v'
uint16_t frequency;
uint16_t requested_power_mW;
uint8_t control_mode;
uint8_t pit_mode;
uint16_t power_mW;
// command 's'
int16_t temperature;
// command 'r'
uint16_t min_frequency;
uint16_t max_frequency;
uint16_t max_power_mW;
};
const Settings &settings() const { return _settings; }
inline Tramp() : Protocol(BAUDRATE)
{
_tx_buf[0] = 0x0F;
}
int get_settings() override;
int reset() override;
int set_power(int16_t power_mW) override;
int set_frequency(int16_t frequency_MHz) override;
int set_pit_mode(bool onoff) override;
bool print_settings() override;
bool copy_to(vtx_s *msg) override;
// Additional methods not part of the Protocol interface
int get_status();
int get_temperature();
private:
int rx_parser(uint8_t c) override;
int transmit(const uint8_t *buf, size_t len);
static uint8_t crc8(const uint8_t *data);
enum {
COMMAND_RESET = 'r', // 0x72
COMMAND_GET_TEMPERATURE = 's', // 0x73
COMMAND_GET_SETTINGS = 'v', // 0x76
COMMAND_SET_POWER = 'P', // 0x50
COMMAND_SET_FREQUENCY = 'F', // 0x46
COMMAND_SET_MODE = 'I', // 0x49
};
struct Frame {
uint8_t start{0x0F};
uint8_t command;
uint8_t payload[12];
uint8_t crc;
uint8_t end{0x00};
} __attribute__((packed));
static_assert(sizeof(Frame) == 16, "Tramp frame size wrong");
Settings _settings{};
uint8_t _read_data_length{};
int8_t _requested_power_level{-1};
};
} // namespace vtx