2017-02-05 22:15:19 -04:00
/*
This program is free software : you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation , either version 3 of the License , or
( at your option ) any later version .
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 .
You should have received a copy of the GNU General Public License
along with this program . If not , see < http : //www.gnu.org/licenses/>.
*/
/*
SRV_Channel . cpp - object to separate input and output channel
ranges , trim and reversal
*/
# include <AP_HAL/AP_HAL.h>
# include <AP_Math/AP_Math.h>
2022-09-29 20:10:41 -03:00
# include <AP_Scheduler/AP_Scheduler.h>
# include <AP_Vehicle/AP_Vehicle_Type.h>
2017-02-05 22:15:19 -04:00
# include "SRV_Channel.h"
2022-08-19 12:06:24 -03:00
# include <AP_Logger/AP_Logger.h>
2023-04-10 18:49:31 -03:00
# include <AP_KDECAN/AP_KDECAN.h>
2017-02-05 22:15:19 -04:00
2020-05-31 09:52:33 -03:00
# if HAL_MAX_CAN_PROTOCOL_DRIVERS
# include <AP_CANManager/AP_CANManager.h>
2023-04-06 21:18:02 -03:00
# include <AP_DroneCAN/AP_DroneCAN.h>
2019-12-09 00:31:29 -04:00
# include <AP_PiccoloCAN/AP_PiccoloCAN.h>
2018-03-09 11:35:43 -04:00
# endif
2021-04-29 02:12:58 -03:00
# if NUM_SERVO_CHANNELS == 0
# pragma GCC diagnostic ignored "-Wtype-limits"
# endif
2017-02-05 22:15:19 -04:00
extern const AP_HAL : : HAL & hal ;
SRV_Channel * SRV_Channels : : channels ;
2019-02-10 00:59:44 -04:00
SRV_Channels * SRV_Channels : : _singleton ;
2020-12-01 07:30:12 -04:00
2022-04-08 04:20:50 -03:00
# if AP_VOLZ_ENABLED
2017-11-02 23:27:29 -03:00
AP_Volz_Protocol * SRV_Channels : : volz_ptr ;
2022-04-08 04:20:50 -03:00
# endif
2023-06-15 05:25:10 -03:00
# if AP_SBUSOUTPUT_ENABLED
2017-11-22 13:40:44 -04:00
AP_SBusOut * SRV_Channels : : sbus_ptr ;
2022-04-08 04:20:57 -03:00
# endif
# if AP_ROBOTISSERVO_ENABLED
2018-12-18 23:28:35 -04:00
AP_RobotisServo * SRV_Channels : : robotis_ptr ;
2022-04-08 04:20:57 -03:00
# endif
2021-11-23 00:53:29 -04:00
2021-11-23 00:52:22 -04:00
# if AP_FETTEC_ONEWIRE_ENABLED
2021-02-05 14:16:48 -04:00
AP_FETtecOneWire * SRV_Channels : : fetteconwire_ptr ;
# endif
2020-12-01 07:30:12 -04:00
2020-05-24 23:45:17 -03:00
uint16_t SRV_Channels : : override_counter [ NUM_SERVO_CHANNELS ] ;
2018-04-01 22:16:44 -03:00
# if HAL_SUPPORT_RCOUT_SERIAL
2018-03-24 19:23:03 -03:00
AP_BLHeli * SRV_Channels : : blheli_ptr ;
2018-04-01 22:16:44 -03:00
# endif
2021-01-11 22:02:50 -04:00
uint32_t SRV_Channels : : disabled_mask ;
uint32_t SRV_Channels : : digital_mask ;
uint32_t SRV_Channels : : reversible_mask ;
2022-01-02 13:40:16 -04:00
uint32_t SRV_Channels : : invalid_mask ;
2017-11-02 23:27:29 -03:00
2017-02-05 22:15:19 -04:00
bool SRV_Channels : : disabled_passthrough ;
bool SRV_Channels : : initialised ;
2019-01-20 21:36:10 -04:00
bool SRV_Channels : : emergency_stop ;
2019-04-11 09:13:23 -03:00
Bitmask < SRV_Channel : : k_nr_aux_servo_functions > SRV_Channels : : function_mask ;
2017-02-05 22:15:19 -04:00
SRV_Channels : : srv_function SRV_Channels : : functions [ SRV_Channel : : k_nr_aux_servo_functions ] ;
2022-01-16 09:06:13 -04:00
SRV_Channels : : slew_list * SRV_Channels : : _slew ;
2017-02-05 22:15:19 -04:00
const AP_Param : : GroupInfo SRV_Channels : : var_info [ ] = {
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 1)
2017-02-05 22:15:19 -04:00
// @Group: 1_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 0 ] , " 1_ " , 1 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 2)
2017-02-05 22:15:19 -04:00
// @Group: 2_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 1 ] , " 2_ " , 2 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 3)
2017-02-05 22:15:19 -04:00
// @Group: 3_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 2 ] , " 3_ " , 3 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 4)
2017-02-05 22:15:19 -04:00
// @Group: 4_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 3 ] , " 4_ " , 4 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 5)
2017-02-05 22:15:19 -04:00
// @Group: 5_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 4 ] , " 5_ " , 5 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 6)
2017-02-05 22:15:19 -04:00
// @Group: 6_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 5 ] , " 6_ " , 6 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 7)
2017-02-05 22:15:19 -04:00
// @Group: 7_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 6 ] , " 7_ " , 7 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 8)
2017-02-05 22:15:19 -04:00
// @Group: 8_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 7 ] , " 8_ " , 8 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 9)
2017-02-05 22:15:19 -04:00
// @Group: 9_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 8 ] , " 9_ " , 9 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 10)
2017-02-05 22:15:19 -04:00
// @Group: 10_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 9 ] , " 10_ " , 10 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 11)
2017-02-05 22:15:19 -04:00
// @Group: 11_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 10 ] , " 11_ " , 11 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 12)
2017-02-05 22:15:19 -04:00
// @Group: 12_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 11 ] , " 12_ " , 12 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 13)
2017-02-05 22:15:19 -04:00
// @Group: 13_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 12 ] , " 13_ " , 13 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 14)
2017-02-05 22:15:19 -04:00
// @Group: 14_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 13 ] , " 14_ " , 14 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 15)
2017-02-05 22:15:19 -04:00
// @Group: 15_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 14 ] , " 15_ " , 15 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-02-05 22:15:19 -04:00
2020-12-01 07:30:12 -04:00
# if (NUM_SERVO_CHANNELS >= 16)
2017-02-05 22:15:19 -04:00
// @Group: 16_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 15 ] , " 16_ " , 16 , SRV_Channels , SRV_Channel ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-07-25 00:23:09 -03:00
2020-12-01 07:30:12 -04:00
# ifndef HAL_BUILD_AP_PERIPH
2020-06-29 11:53:26 -03:00
// @Param{Plane}: _AUTO_TRIM
2017-02-05 22:15:19 -04:00
// @DisplayName: Automatic servo trim
2020-01-19 15:50:25 -04:00
// @Description: This enables automatic servo trim in flight. Servos will be trimed in stabilized flight modes when the aircraft is close to level. Changes to servo trim will be saved every 10 seconds and will persist between flights. The automatic trim won't go more than 20% away from a centered trim.
2017-02-05 22:15:19 -04:00
// @Values: 0:Disable,1:Enable
// @User: Advanced
2017-02-07 19:48:39 -04:00
AP_GROUPINFO_FRAME ( " _AUTO_TRIM " , 17 , SRV_Channels , auto_trim , 0 , AP_PARAM_FRAME_PLANE ) ,
2020-12-01 07:30:12 -04:00
# endif
2017-04-02 11:55:50 -03:00
2017-07-25 00:15:00 -03:00
// @Param: _RATE
// @DisplayName: Servo default output rate
2023-06-22 20:10:42 -03:00
// @Description: Default output rate in Hz for all PWM outputs.
2017-07-16 20:19:45 -03:00
// @Range: 25 400
// @User: Advanced
// @Units: Hz
2017-07-25 00:15:00 -03:00
AP_GROUPINFO ( " _RATE " , 18 , SRV_Channels , default_rate , 50 ) ,
2017-07-25 00:23:09 -03:00
2022-04-08 04:20:50 -03:00
# if AP_VOLZ_ENABLED
2017-12-08 17:08:00 -04:00
// @Group: _VOLZ_
2017-11-02 23:27:29 -03:00
// @Path: ../AP_Volz_Protocol/AP_Volz_Protocol.cpp
AP_SUBGROUPINFO ( volz , " _VOLZ_ " , 19 , SRV_Channels , AP_Volz_Protocol ) ,
2022-04-08 04:20:50 -03:00
# endif
2017-11-02 23:27:29 -03:00
2023-06-15 05:25:10 -03:00
# if AP_SBUSOUTPUT_ENABLED
2017-12-08 17:08:00 -04:00
// @Group: _SBUS_
2017-11-22 13:40:44 -04:00
// @Path: ../AP_SBusOut/AP_SBusOut.cpp
AP_SUBGROUPINFO ( sbus , " _SBUS_ " , 20 , SRV_Channels , AP_SBusOut ) ,
2023-06-15 05:25:10 -03:00
# endif
2017-11-22 13:40:44 -04:00
2018-04-01 22:16:44 -03:00
# if HAL_SUPPORT_RCOUT_SERIAL
2018-03-24 19:23:03 -03:00
// @Group: _BLH_
// @Path: ../AP_BLHeli/AP_BLHeli.cpp
AP_SUBGROUPINFO ( blheli , " _BLH_ " , 21 , SRV_Channels , AP_BLHeli ) ,
2018-04-01 22:16:44 -03:00
# endif
2018-07-18 03:27:38 -03:00
2022-04-08 04:20:57 -03:00
# if AP_ROBOTISSERVO_ENABLED
2018-12-18 23:28:35 -04:00
// @Group: _ROB_
// @Path: ../AP_RobotisServo/AP_RobotisServo.cpp
AP_SUBGROUPINFO ( robotis , " _ROB_ " , 22 , SRV_Channels , AP_RobotisServo ) ,
2022-04-08 04:20:57 -03:00
# endif
2021-11-23 00:52:22 -04:00
# if AP_FETTEC_ONEWIRE_ENABLED
2021-02-05 14:16:48 -04:00
// @Group: _FTW_
// @Path: ../AP_FETtecOneWire/AP_FETtecOneWire.cpp
AP_SUBGROUPINFO ( fetteconwire , " _FTW_ " , 25 , SRV_Channels , AP_FETtecOneWire ) ,
# endif
2021-03-02 18:18:47 -04:00
// @Param: _DSHOT_RATE
// @DisplayName: Servo DShot output rate
2023-06-22 20:10:42 -03:00
// @Description: DShot output rate for all outputs as a multiple of the loop rate. 0 sets the output rate to be fixed at 1Khz for low loop rates. This value should never be set below 500Hz.
2021-03-02 18:18:47 -04:00
// @Values: 0:1Khz,1:loop-rate,2:double loop-rate,3:triple loop-rate,4:quadruple loop rate
// @User: Advanced
AP_GROUPINFO ( " _DSHOT_RATE " , 23 , SRV_Channels , dshot_rate , 0 ) ,
2021-04-28 17:50:49 -03:00
// @Param: _DSHOT_ESC
// @DisplayName: Servo DShot ESC type
2023-06-22 20:10:42 -03:00
// @Description: DShot ESC type for all outputs. The ESC type affects the range of DShot commands available and the bit widths used. None means that no dshot commands will be executed. Some ESC types support Extended DShot Telemetry (EDT) which allows telemetry other than RPM data to be returned when using bi-directional dshot. If you enable EDT you must install EDT capable firmware for correct operation.
2024-08-02 21:59:23 -03:00
// @Values: 0:None,1:BLHeli32/Kiss/AM32,2:BLHeli_S/BlueJay,3:BLHeli32/AM32/Kiss+EDT,4:BLHeli_S/BlueJay+EDT
2021-04-28 17:50:49 -03:00
// @User: Advanced
AP_GROUPINFO ( " _DSHOT_ESC " , 24 , SRV_Channels , dshot_esc_type , 0 ) ,
2021-08-03 21:24:01 -03:00
// @Param: _GPIO_MASK
// @DisplayName: Servo GPIO mask
2023-06-22 20:10:42 -03:00
// @Description: Bitmask of outputs which will be available as GPIOs. Any output with either the function set to -1 or with the corresponding bit set in this mask will be available for use as a GPIO pin
2021-01-11 22:02:50 -04:00
// @Bitmask: 0:Servo 1, 1:Servo 2, 2:Servo 3, 3:Servo 4, 4:Servo 5, 5:Servo 6, 6:Servo 7, 7:Servo 8, 8:Servo 9, 9:Servo 10, 10:Servo 11, 11:Servo 12, 12:Servo 13, 13:Servo 14, 14:Servo 15, 15:Servo 16, 16:Servo 17, 17:Servo 18, 18:Servo 19, 19:Servo 20, 20:Servo 21, 21:Servo 22, 22:Servo 23, 23:Servo 24, 24:Servo 25, 25:Servo 26, 26:Servo 27, 27:Servo 28, 28:Servo 29, 29:Servo 30, 30:Servo 31, 31:Servo 32
2021-08-03 21:24:01 -03:00
// @User: Advanced
// @RebootRequired: True
2023-06-22 20:10:42 -03:00
AP_GROUPINFO ( " _GPIO_MASK " , 26 , SRV_Channels , gpio_mask , 0 ) ,
// indexes 27-43 used by SERVO_32_ENABLEd group of params
// @Param: _RC_FS_MSK
// @DisplayName: Servo RC Failsafe Mask
2023-08-11 04:39:58 -03:00
// @Description: Bitmask of scaled passthru output channels which will be set to their trim value during rc failsafe instead of holding their last position before failsafe.
2023-06-22 20:10:42 -03:00
// @Bitmask: 0:RCIN1Scaled, 1:RCIN2Scaled, 2:RCIN3Scaled, 3:RCIN4Scaled, 4:RCIN5Scaled, 5:RCIN6Scaled, 6:RCIN7Scaled, 7:RCIN8Scaled, 8:RCIN9Scaled, 9:RCIN10Scaled, 10:RCIN11Scaled, 11:SRCIN12Scaled, 12:RCIN13Scaled, 13:RCIN14Scaled, 14:RCIN15Scaled, 15:RCIN16Scaled
// @User: Advanced
AP_GROUPINFO ( " _RC_FS_MSK " , 44 , SRV_Channels , rc_fs_mask , 0 ) ,
2022-05-15 18:51:34 -03:00
# if (NUM_SERVO_CHANNELS >= 17)
// @Param: _32_ENABLE
// @DisplayName: Enable outputs 17 to 31
// @Description: This allows for up to 32 outputs, enabling parameters for outputs above 16
// @User: Advanced
// @Values: 0:Disabled,1:Enabled
AP_GROUPINFO_FLAGS ( " _32_ENABLE " , 43 , SRV_Channels , enable_32_channels , 0 , AP_PARAM_FLAG_ENABLE ) ,
# endif
2021-01-11 22:02:50 -04:00
# if (NUM_SERVO_CHANNELS >= 17)
// @Group: 17_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 16 ] , " 17_ " , 27 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 18)
// @Group: 18_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 17 ] , " 18_ " , 28 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 19)
// @Group: 19_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 18 ] , " 19_ " , 29 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 20)
// @Group: 20_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 19 ] , " 20_ " , 30 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 21)
// @Group: 21_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 20 ] , " 21_ " , 31 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 22)
// @Group: 22_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 21 ] , " 22_ " , 32 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 23)
// @Group: 23_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 22 ] , " 23_ " , 33 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 24)
// @Group: 24_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 23 ] , " 24_ " , 34 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 25)
// @Group: 25_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 24 ] , " 25_ " , 35 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 26)
// @Group: 26_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 25 ] , " 26_ " , 36 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 27)
// @Group: 27_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 26 ] , " 27_ " , 37 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 28)
// @Group: 28_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 27 ] , " 28_ " , 38 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 29)
// @Group: 29_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 28 ] , " 29_ " , 39 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 30)
// @Group: 30_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 29 ] , " 30_ " , 40 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 31)
// @Group: 31_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 30 ] , " 31_ " , 41 , SRV_Channels , SRV_Channel ) ,
# endif
# if (NUM_SERVO_CHANNELS >= 32)
// @Group: 32_
// @Path: SRV_Channel.cpp
AP_SUBGROUPINFO ( obj_channels [ 31 ] , " 32_ " , 42 , SRV_Channels , SRV_Channel ) ,
# endif
2017-02-05 22:15:19 -04:00
AP_GROUPEND
} ;
/*
constructor
*/
SRV_Channels : : SRV_Channels ( void )
{
2019-02-10 00:59:44 -04:00
_singleton = this ;
2017-02-05 22:15:19 -04:00
channels = obj_channels ;
2017-07-25 00:23:09 -03:00
2017-02-05 22:15:19 -04:00
// set defaults from the parameter table
AP_Param : : setup_object_defaults ( this , var_info ) ;
// setup ch_num on channels
for ( uint8_t i = 0 ; i < NUM_SERVO_CHANNELS ; i + + ) {
channels [ i ] . ch_num = i ;
2022-01-02 13:41:22 -04:00
# if NUM_SERVO_CHANNELS > 16
if ( i > = 16 ) {
// default to GPIO, this disables the pin and stops logging
channels [ i ] . function . set_default ( SRV_Channel : : k_GPIO ) ;
}
# endif
2017-02-05 22:15:19 -04:00
}
2017-11-02 23:27:29 -03:00
2021-11-23 00:53:29 -04:00
# if AP_FETTEC_ONEWIRE_ENABLED
fetteconwire_ptr = & fetteconwire ;
# endif
2022-04-08 04:20:50 -03:00
# if AP_VOLZ_ENABLED
2017-11-02 23:27:29 -03:00
volz_ptr = & volz ;
2022-04-08 04:20:50 -03:00
# endif
2023-06-15 05:25:10 -03:00
# if AP_SBUSOUTPUT_ENABLED
2017-11-22 13:40:44 -04:00
sbus_ptr = & sbus ;
2022-04-08 04:20:57 -03:00
# endif
# if AP_ROBOTISSERVO_ENABLED
2018-12-18 23:28:35 -04:00
robotis_ptr = & robotis ;
2022-04-08 04:20:57 -03:00
# endif // AP_ROBOTISSERVO_ENABLED
2018-04-01 22:16:44 -03:00
# if HAL_SUPPORT_RCOUT_SERIAL
2018-03-24 19:23:03 -03:00
blheli_ptr = & blheli ;
2018-04-01 22:16:44 -03:00
# endif
2021-03-02 18:18:47 -04:00
}
// SRV_Channels initialization
2022-09-05 14:06:42 -03:00
void SRV_Channels : : init ( uint32_t motor_mask , AP_HAL : : RCOutput : : output_mode mode )
2021-03-02 18:18:47 -04:00
{
2021-05-01 12:39:32 -03:00
// initialize BLHeli late so that all of the masks it might setup don't get trodden on by motor initialization
# if HAL_SUPPORT_RCOUT_SERIAL
2022-09-05 14:06:42 -03:00
blheli_ptr - > init ( motor_mask , mode ) ;
2021-05-01 12:39:32 -03:00
# endif
2021-12-07 04:10:20 -04:00
# ifndef HAL_BUILD_AP_PERIPH
2021-03-02 18:18:47 -04:00
hal . rcout - > set_dshot_rate ( _singleton - > dshot_rate , AP : : scheduler ( ) . get_loop_rate_hz ( ) ) ;
2021-12-07 04:10:20 -04:00
# endif
2017-02-05 22:15:19 -04:00
}
/*
save adjusted trims
*/
void SRV_Channels : : save_trim ( void )
{
for ( uint8_t i = 0 ; i < NUM_SERVO_CHANNELS ; i + + ) {
if ( trimmed_mask & ( 1U < < i ) ) {
channels [ i ] . servo_trim . set_and_save ( channels [ i ] . servo_trim . get ( ) ) ;
}
}
trimmed_mask = 0 ;
}
2018-08-22 04:18:36 -03:00
void SRV_Channels : : setup_failsafe_trim_all_non_motors ( void )
2017-02-05 22:15:19 -04:00
{
for ( uint8_t i = 0 ; i < NUM_SERVO_CHANNELS ; i + + ) {
2018-08-22 04:18:36 -03:00
if ( ! SRV_Channel : : is_motor ( channels [ i ] . get_function ( ) ) ) {
hal . rcout - > set_failsafe_pwm ( 1U < < channels [ i ] . ch_num , channels [ i ] . servo_trim ) ;
}
2017-02-05 22:15:19 -04:00
}
}
/*
run calc_pwm for all channels
*/
void SRV_Channels : : calc_pwm ( void )
{
2022-01-16 09:06:13 -04:00
// slew rate limit functions
for ( slew_list * slew = _slew ; slew ; slew = slew - > next ) {
if ( is_positive ( slew - > max_change ) ) {
// treat negative or zero slew rate as disabled
functions [ slew - > func ] . output_scaled = constrain_float ( functions [ slew - > func ] . output_scaled , slew - > last_scaled_output - slew - > max_change , slew - > last_scaled_output + slew - > max_change ) ;
}
slew - > last_scaled_output = functions [ slew - > func ] . output_scaled ;
}
2020-05-24 23:45:17 -03:00
WITH_SEMAPHORE ( _singleton - > override_counter_sem ) ;
2017-02-05 22:15:19 -04:00
for ( uint8_t i = 0 ; i < NUM_SERVO_CHANNELS ; i + + ) {
2020-05-24 23:45:17 -03:00
// check if channel has been locked out for this loop
// if it has, decrement the loop count for that channel
if ( override_counter [ i ] = = 0 ) {
2020-06-07 17:04:56 -03:00
channels [ i ] . set_override ( false ) ;
2020-05-24 23:45:17 -03:00
} else {
2020-06-07 17:04:56 -03:00
channels [ i ] . set_override ( true ) ;
2020-05-24 23:45:17 -03:00
override_counter [ i ] - - ;
}
2021-12-14 23:58:47 -04:00
if ( channels [ i ] . valid_function ( ) ) {
channels [ i ] . calc_pwm ( functions [ channels [ i ] . function . get ( ) ] . output_scaled ) ;
}
2017-02-05 22:15:19 -04:00
}
}
2017-04-17 03:53:05 -03:00
// set output value for a specific function channel as a pwm value
void SRV_Channels : : set_output_pwm_chan ( uint8_t chan , uint16_t value )
{
if ( chan < NUM_SERVO_CHANNELS ) {
channels [ chan ] . set_output_pwm ( value ) ;
}
}
2017-11-02 23:27:29 -03:00
2024-03-07 19:56:02 -04:00
# if AP_SCRIPTING_ENABLED && AP_SCHEDULER_ENABLED
2020-05-24 23:45:17 -03:00
// set output value for a specific function channel as a pwm value with loop based timeout
// timeout_ms of zero will clear override of the channel
// minimum override is 1 MAIN_LOOP
void SRV_Channels : : set_output_pwm_chan_timeout ( uint8_t chan , uint16_t value , uint16_t timeout_ms )
{
WITH_SEMAPHORE ( _singleton - > override_counter_sem ) ;
if ( chan < NUM_SERVO_CHANNELS ) {
const uint32_t loop_period_us = AP : : scheduler ( ) . get_loop_period_us ( ) ;
// round up so any non-zero requested value will result in at least one loop
const uint32_t loop_count = ( ( timeout_ms * 1000U ) + ( loop_period_us - 1U ) ) / loop_period_us ;
override_counter [ chan ] = constrain_int32 ( loop_count , 0 , UINT16_MAX ) ;
2020-06-07 17:04:56 -03:00
channels [ chan ] . set_override ( true ) ;
2021-09-14 16:25:18 -03:00
const bool had_pwm = SRV_Channel : : have_pwm_mask & ( 1U < < chan ) ;
2020-06-07 17:04:56 -03:00
channels [ chan ] . set_output_pwm ( value , true ) ;
2021-09-14 16:25:18 -03:00
if ( ! had_pwm ) {
// clear the have PWM mask so the channel will default back to the scaled value when timeout expires
// this is also cleared by set_output_scaled but that requires it to be re-called as some point
// after the timeout is applied
// note that we can't default back to a pre-override PWM value as it is not stored
// checking had_pwm means the PWM will not change after the timeout, this was the existing behaviour
SRV_Channel : : have_pwm_mask & = ~ ( 1U < < chan ) ;
}
2020-05-24 23:45:17 -03:00
}
}
2024-03-07 19:56:02 -04:00
# endif // AP_SCRIPTING_ENABLED
2020-05-24 23:45:17 -03:00
2017-11-02 23:27:29 -03:00
/*
wrapper around hal . rcout - > cork ( )
*/
void SRV_Channels : : cork ( )
{
2018-03-09 11:35:43 -04:00
hal . rcout - > cork ( ) ;
2017-11-02 23:27:29 -03:00
}
/*
wrapper around hal . rcout - > push ( )
*/
void SRV_Channels : : push ( )
{
hal . rcout - > push ( ) ;
2018-07-18 03:27:38 -03:00
2022-04-08 04:20:50 -03:00
# if AP_VOLZ_ENABLED
2017-11-02 23:27:29 -03:00
// give volz library a chance to update
volz_ptr - > update ( ) ;
2022-04-08 04:20:50 -03:00
# endif
2017-11-22 13:40:44 -04:00
2023-06-15 05:25:10 -03:00
# if AP_SBUSOUTPUT_ENABLED
2017-11-22 13:40:44 -04:00
// give sbus library a chance to update
sbus_ptr - > update ( ) ;
2023-06-15 05:25:10 -03:00
# endif
2018-04-01 22:16:44 -03:00
2022-04-08 04:20:57 -03:00
# if AP_ROBOTISSERVO_ENABLED
2018-12-18 23:28:35 -04:00
// give robotis library a chance to update
robotis_ptr - > update ( ) ;
2022-04-08 04:20:57 -03:00
# endif
2021-12-07 04:10:20 -04:00
2018-04-01 22:16:44 -03:00
# if HAL_SUPPORT_RCOUT_SERIAL
// give blheli telemetry a chance to update
blheli_ptr - > update_telemetry ( ) ;
# endif
2018-03-09 11:35:43 -04:00
2021-11-23 00:53:29 -04:00
# if AP_FETTEC_ONEWIRE_ENABLED
fetteconwire_ptr - > update ( ) ;
# endif
2023-04-10 18:49:31 -03:00
# if AP_KDECAN_ENABLED
if ( AP : : kdecan ( ) ! = nullptr ) {
AP : : kdecan ( ) - > update ( ) ;
}
# endif
2023-04-08 01:09:11 -03:00
# if HAL_ENABLE_DRONECAN_DRIVERS
2018-07-04 16:04:30 -03:00
// push outputs to CAN
2018-07-18 03:27:38 -03:00
uint8_t can_num_drivers = AP : : can ( ) . get_num_drivers ( ) ;
for ( uint8_t i = 0 ; i < can_num_drivers ; i + + ) {
2020-05-31 09:52:33 -03:00
switch ( AP : : can ( ) . get_driver_type ( i ) ) {
2023-04-18 05:04:51 -03:00
case AP_CAN : : Protocol : : DroneCAN : {
2023-04-08 01:27:51 -03:00
AP_DroneCAN * ap_dronecan = AP_DroneCAN : : get_dronecan ( i ) ;
2023-04-06 21:18:02 -03:00
if ( ap_dronecan = = nullptr ) {
2018-07-04 16:04:30 -03:00
continue ;
}
2023-04-06 21:18:02 -03:00
ap_dronecan - > SRV_push_servos ( ) ;
2018-07-04 16:04:30 -03:00
break ;
}
2019-12-09 00:31:29 -04:00
# if HAL_PICCOLO_CAN_ENABLE
2023-04-18 05:04:51 -03:00
case AP_CAN : : Protocol : : PiccoloCAN : {
2019-12-09 00:31:29 -04:00
AP_PiccoloCAN * ap_pcan = AP_PiccoloCAN : : get_pcan ( i ) ;
if ( ap_pcan = = nullptr ) {
continue ;
}
ap_pcan - > update ( ) ;
break ;
}
# endif
2023-04-18 05:04:51 -03:00
case AP_CAN : : Protocol : : None :
2018-07-04 16:04:30 -03:00
default :
break ;
2018-03-09 11:35:43 -04:00
}
}
2020-05-31 09:52:33 -03:00
# endif // HAL_NUM_CAN_IFACES
2018-03-09 11:35:43 -04:00
}
2020-09-10 08:17:56 -03:00
void SRV_Channels : : zero_rc_outputs ( )
{
/* Send an invalid signal to the motors to prevent spinning due to
* neutral ( 1500 ) pwm pulse being cut short . For that matter ,
* send an invalid signal to all channels to prevent
* undesired / unexpected behavior
*/
cork ( ) ;
2022-01-29 08:01:42 -04:00
for ( uint8_t i = 0 ; i < NUM_SERVO_CHANNELS ; i + + ) {
2020-09-10 08:17:56 -03:00
hal . rcout - > write ( i , 0 ) ;
}
push ( ) ;
}
2021-08-03 21:24:01 -03:00
/*
return true if a channel should be available as a GPIO
*/
bool SRV_Channels : : is_GPIO ( uint8_t channel )
{
if ( channel_function ( channel ) = = SRV_Channel : : k_GPIO ) {
return true ;
}
if ( _singleton ! = nullptr & & ( _singleton - > gpio_mask & ( 1U < < channel ) ) ! = 0 ) {
// user has set this channel in SERVO_GPIO_MASK
return true ;
}
return false ;
}
2022-08-19 12:06:24 -03:00
// Set E - stop
void SRV_Channels : : set_emergency_stop ( bool state ) {
# if HAL_LOGGING_ENABLED
if ( state ! = emergency_stop ) {
AP_Logger * logger = AP_Logger : : get_singleton ( ) ;
if ( logger & & logger - > logging_enabled ( ) ) {
logger - > Write_Event ( state ? LogEvent : : MOTORS_EMERGENCY_STOPPED : LogEvent : : MOTORS_EMERGENCY_STOP_CLEARED ) ;
}
}
# endif
emergency_stop = state ;
}