Tools: add some parameter documentation

SITL: vehicle_test_suite.py parameters removal from whitelist

SITL: Add known unit amp hour

SITL: Add known unit Ah

Co-authored-by: Peter Barker <pb-gh@barker.dropbear.id.au>
This commit is contained in:
Yuxin Pan 2024-09-10 17:45:13 +10:00 committed by Peter Barker
parent 41ffc7c860
commit e7359c12f1
2 changed files with 3 additions and 15 deletions

View File

@ -117,13 +117,14 @@ known_units = {
'dB' : 'decibel' ,
# compound
'kB' : 'kilobytes' ,
'kB' : 'kilobytes' ,
'MB' : 'megabyte' ,
'm.m/s/s' : 'square meter per square second',
'deg/m/s' : 'degrees per meter per second' ,
'm/s/m' : 'meters per second per meter' , # Why not use Hz here ????
'mGauss/A': 'milligauss per ampere' ,
'mAh' : 'milliampere hour' ,
'mAh' : 'milliampere hour' ,
'Ah' : 'ampere hour' ,
'A/V' : 'ampere per volt' ,
'm/V' : 'meters per volt' ,
'gravities': 'standard acceleration due to gravity' , # g_n would be a more correct unit, but IMHO no one understands what g_n means

View File

@ -2559,14 +2559,9 @@ class TestSuite(ABC):
def get_sim_parameter_documentation_get_whitelist(self):
# common parameters
ret = set([
"SIM_ACC_FILE_RW",
"SIM_ACC_TRIM_X",
"SIM_ACC_TRIM_Y",
"SIM_ACC_TRIM_Z",
"SIM_ADSB_ALT",
"SIM_ADSB_COUNT",
"SIM_ADSB_RADIUS",
"SIM_ADSB_TX",
"SIM_ARSPD2_OFS",
"SIM_ARSPD2_RND",
"SIM_ARSPD_OFS",
@ -2591,7 +2586,6 @@ class TestSuite(ABC):
"SIM_BAR3_WCF_LFT",
"SIM_BAR3_WCF_RGT",
"SIM_BAR3_WCF_UP",
"SIM_BARO_COUNT",
"SIM_BARO_DELAY",
"SIM_BARO_DISABLE",
"SIM_BARO_FREEZE",
@ -2601,12 +2595,6 @@ class TestSuite(ABC):
"SIM_BARO_WCF_LFT",
"SIM_BARO_WCF_RGT",
"SIM_BARO_WCF_UP",
"SIM_BATT_CAP_AH",
"SIM_BAUDLIMIT_EN",
"SIM_DRIFT_SPEED",
"SIM_DRIFT_TIME",
"SIM_EFI_TYPE",
"SIM_ESC_ARM_RPM",
"SIM_FTOWESC_ENA",
"SIM_FTOWESC_POW",
"SIM_GND_BEHAV",
@ -2616,7 +2604,6 @@ class TestSuite(ABC):
"SIM_GYR4_RND",
"SIM_GYR5_RND",
"SIM_GYR_FAIL_MSK",
"SIM_GYR_FILE_RW",
"SIM_IE24_ENABLE",
"SIM_IE24_ERROR",
"SIM_IE24_STATE",