Skip to content

Commit

Permalink
Renaming "allowed" literals according to guidelines
Browse files Browse the repository at this point in the history
Notes:

Private-branch (CARFIT) not updated - private branch so
not covered by recommendations

Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
  • Loading branch information
erikbosch committed Feb 1, 2022
1 parent 515e73e commit 72e3db6
Show file tree
Hide file tree
Showing 12 changed files with 58 additions and 58 deletions.
8 changes: 4 additions & 4 deletions spec/Body/Body.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ BodyType:
RefuelPosition:
datatype: string
type: attribute
allowed: ["front_left", "front_right", "middle_left", "middle_right", "rear_left", "rear_right"]
allowed: [FRONT_LEFT, FRONT_RIGHT, MIDDLE_LEFT, MIDDLE_RIGHT, REAR_LEFT, REAR_RIGHT]
description: Location of the fuel cap or charge port.

#
Expand Down Expand Up @@ -93,7 +93,7 @@ Windshield.Wiping:
Windshield.Wiping.Status:
datatype: string
type: actuator
allowed: ["off", "slow", "medium", "fast", "interval", "rainsensor"]
allowed: [OFF, SLOW, MEDIUM, FAST, INTERVAL, RAIN_SENSOR]
description: Wiper status.

Windshield.IsHeatingOn:
Expand Down Expand Up @@ -150,8 +150,8 @@ ChargingPort:
ChargingPort.Type:
datatype: string
type: attribute
allowed: [ "unknown", "Not_Fitted", "AC_Type_1", "AC_Type_2", "AC_GBT", "AC_DC_Type_1_Combo", "AC_DC_Type_2_Combo", "DC_GBT", "DC_Chademo" ]
default: "unknown"
allowed: [UNKNOWN, NOT_FITTED, AC_TYPE_1, AC_TYPE_2, AC_GBT, AC_DC_TYPE_1_COMBO, AC_DC_TYPE_2_COMBO, DC_GBT, DC_CHADEMO]
default: UNKNOWN
description: Indicates the primary charging type fitted to the vehicle.

##
Expand Down
4 changes: 2 additions & 2 deletions spec/Cabin/Cabin.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Sunroof.Position:
Sunroof.Switch:
datatype: string
type: actuator
allowed: [ "Inactive", "Close", "Open", "OneShotClose", "OneShotOpen", "TiltUp", "TiltDown" ]
allowed: [INACTIVE, CLOSE, OPEN, ONE_SHOT_CLOSE, ONE_SHOT_OPEN, TILT_UP, TILT_DOWN]
description: Switch controlling sliding action such as window, sunroof, or shade.

Sunroof.Shade:
Expand Down Expand Up @@ -182,5 +182,5 @@ Convertible:
Convertible.Status:
datatype: string
type: sensor
allowed: ["undefined", "closed", "open", "closing", "opening", "stalled"]
allowed: [UNDEFINED, CLOSED, OPEN, CLOSING, OPENING, STALLED]
description: Roof status on convertible vehicles.
18 changes: 9 additions & 9 deletions spec/Cabin/Infotainment.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Media:
Media.Action:
datatype: string
type: actuator
allowed: [ "unknown", "Stop", "Play", "FastForward", "FastBackward", "SkipForward", "SkipBackward" ]
allowed: [UNKNOWN, STOP, PLAY, FAST_FORWARD, FAST_BACKWARD, SKIP_FORWARD, SKIP_BACKWARD]
description: Tells if the media was

Media.Played:
Expand All @@ -26,7 +26,7 @@ Media.Played:
Media.Played.Source:
datatype: string
type: actuator
allowed: [ "unknown", "SiriusXM", "AM", "FM", "DAB", "TV", "CD", "DVD", "AUX", "USB", "Disk", "Bluetooth", "Internet", "Voice", "Beep" ]
allowed: [UNKNOWN, SIRIUS_XM, AM, FM, DAB, TV, CD, DVD, AUX, USB, DISK, BLUETOOTH, INTERNET, VOICE, BEEP]
description: Media selected for playback

Media.Played.Artist:
Expand Down Expand Up @@ -102,41 +102,41 @@ HMI.CurrentLanguage:
HMI.DateFormat:
datatype: string
type: actuator
allowed: [ "YYYY MM DD", "DD MM YYYY", "MM DD YYYY", "YY MM DD", "DD MM YY", "MM DD YY"]
allowed: [YYYY_MM_DD, DD_MM_YYYY, MM_DD_YYYY, YY_MM_DD, DD_MM_YY, MM_DD_YY]
description: Date format used in the current HMI

HMI.TimeFormat:
datatype: string
type: actuator
allowed: [ "12HR", "24HR" ]
allowed: [HR_12, HR_24]
description: Time format used in the current HMI

HMI.DistanceUnit:
datatype: string
type: actuator
allowed: [ "mi", "km" ]
allowed: [MILES, KILOMETERS]
description: Distance unit used in the current HMI

HMI.FuelEconomyUnits:
datatype: string
type: actuator
allowed: [ "mpg_UK", "mpg_US", "mpl", "km/l", "l/100km" ]
allowed: [MPG_UK, MPG_US, MILES_PER_LITER, KILOMETERS_PER_LITER, LITERS_PER_100_KILOMETERS]
description: Fuel economy unit used in the current HMI

HMI.EVEconomyUnits:
datatype: string
type: actuator
allowed: [ "mi/kWh", "km/kWh", "kWh/100mi", "kWh/100km", "Wh/mi", "Wh/km" ]
allowed: [MILES_PER_KILOWATT_HOUR, KILOMETERS_PER_KILOWATT_HOUR, KILOWATT_HOURS_PER_100_MILES, KILOWATT_HOURS_PER_100_KILOMETERS, WATT_HOURS_PER_MILE, WATT_HOURS_PER_KILOMETER]
description: EV fuel economy unit used in the current HMI

HMI.TemperatureUnit:
datatype: string
type: actuator
allowed: [ "C", "F" ]
allowed: [C, F]
description: Temperature unit used in the current HMI

HMI.DayNightMode:
datatype: string
type: actuator
allowed: [ "Day", "Night" ]
allowed: [DAY, NIGHT]
description: Current display theme
2 changes: 1 addition & 1 deletion spec/Cabin/SingleHVACStation.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ Temperature:
AirDistribution:
datatype: string
type: actuator
allowed: [ "up", "middle", "down" ]
allowed: [UP, MIDDLE, DOWN]
description: Direction of airstream
2 changes: 1 addition & 1 deletion spec/Cabin/SingleSliderSwitch.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@
Switch:
datatype: string
type: actuator
allowed: [ "Inactive", "Close", "Open", "OneShotClose", "OneShotOpen" ]
allowed: [INACTIVE, CLOSE, OPEN, ONE_SHOT_CLOSE, ONE_SHOT_OPEN]
description: Switch controlling sliding action such as window, sunroof, or blind.
4 changes: 2 additions & 2 deletions spec/Chassis/Chassis.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ SteeringWheel.Extension:
SteeringWheel.Position:
datatype: string
type: attribute
default: front_left
allowed: ["front_left", "front_right"]
default: FRONT_LEFT
allowed: [FRONT_LEFT, FRONT_RIGHT]
description: Position of the steering wheel on the left or right side of the vehicle.

#
Expand Down
4 changes: 2 additions & 2 deletions spec/OBD/OBD.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Status.DTCCount:
Status.IgnitionType:
datatype: string
type: sensor
allowed: [ "spark", "compression" ]
allowed: [SPARK, COMPRESSION]
description: Type of the ignition for ICE - spark = spark plug ignition, compression = self-igniting (Diesel engines)

DTCList:
Expand Down Expand Up @@ -362,7 +362,7 @@ DriveCycleStatus.DTCCount:
DriveCycleStatus.IgnitionType:
datatype: string
type: sensor
allowed: [ "spark", "compression" ]
allowed: [SPARK, COMPRESSION]
description: Type of the ignition for ICE - spark = spark plug ignition, compression = self-igniting (Diesel engines)

ControlModuleVoltage:
Expand Down
18 changes: 9 additions & 9 deletions spec/Powertrain/Battery.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Charging.MaximumChargingCurrent:
Charging.ChargePortFlap:
datatype: string
type: actuator
allowed: [ 'open', 'closed' ]
allowed: [OPEN, CLOSED]
description: Status of the charge port cover, can potentially be controlled manually.

Charging.IsChargingCableConnected:
Expand All @@ -134,14 +134,14 @@ Charging.IsChargingCableConnected:
Charging.ChargePlugType:
datatype: string
type: attribute
default: ccs
allowed: [ 'type 1', 'type 2', 'ccs', 'chademo' ]
default: CCS
allowed: [TYPE_1, TYPE_2, CCS, CHADEMO]
description: Type of charge plug available on the vehicle (CSS includes Type2).

Charging.Mode:
datatype: string
type: actuator
allowed: [ 'manual', 'timer', 'grid' ]
allowed: [MANUAL, TIMER, GRID]
description: Control of the charge process - manually initiated (plug-in event, companion app, etc), timer-based or grid-controlled (eg ISO 15118).

Charging.IsCharging:
Expand All @@ -153,7 +153,7 @@ Charging.IsCharging:
Charging.StartStopCharging:
datatype: string
type: actuator
allowed: [ 'start', 'stop' ]
allowed: [START, STOP]
description: Start or stop the charging process.

Charging.ChargeCurrent:
Expand Down Expand Up @@ -191,11 +191,11 @@ Charging.Timer:
Charging.Timer.Mode:
datatype: string
type: actuator
allowed: [ 'inactive', 'starttime', 'endtime' ]
allowed: [INACTIVE, START_TIME, END_TIME]
description: "Defines timer mode for charging:
'inactive' - no timer set, charging may start as soon as battery is connected to a charger.
'starttime' - charging shall start at Charging.Timer.Time.
'endtime' - charging shall be finished (reach StateOfCharge.Target) at Charging.Timer.Time.
INACTIVE - no timer set, charging may start as soon as battery is connected to a charger.
START_TIME - charging shall start at Charging.Timer.Time.
END_TIME - charging shall be finished (reach StateOfCharge.Target) at Charging.Timer.Time.
When charging is completed the vehicle shall change mode to 'inactive' or set a new Charging.Timer.Time.
Charging shall start immediately if mode is 'starttime' or 'endtime' and Charging.Timer.Time is a time in the past."

Expand Down
24 changes: 12 additions & 12 deletions spec/Powertrain/CombustionEngine.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ Bore:
Configuration:
datatype: string
type: attribute
allowed: [ "unknown", "straight", "V", "boxer", "W",
"rotary", "radial", "square", "H", "U", "opposed", "X" ]
allowed: [UNKNOWN, STRAIGHT, V, BOXER, W,
ROTARY, RADIAL, SQUARE, H, U, OPPOSED, X]
description: Engine configuration.
default: "unknown"
default: UNKNOWN

NumberOfCylinders:
datatype: uint16
Expand Down Expand Up @@ -88,26 +88,26 @@ MaxTorque:
AspirationType:
datatype: string
type: attribute
allowed: [ "unknown", "natural", "supercharger", "turbocharger" ]
default: "unknown"
allowed: [UNKNOWN, NATURAL, SUPERCHARGER, TURBOCHARGER]
default: UNKNOWN
description: Type of aspiration (natural, turbocharger, supercharger etc).

FuelType:
datatype: string
type: attribute
allowed: [ "unknown", "gasoline", "diesel", "E85", "CNG" ]
default: "unknown"
allowed: [UNKNOWN, GASOLINE, DIESEL, E85, CNG]
default: UNKNOWN
description: Type of fuel that the engine runs on.

EngineOilLevel:
datatype: string
type: sensor
allowed: [
"critically_low", # Critically low, immediate action required
"low", # Level below recommended range, but not critical
"normal", # Within normal range, no need for driver action
"high", # Level above recommended range, but not critical
"critically_high" # Critically high, immediate action required
CRITICALLY_LOW, # Critically low, immediate action required
LOW, # Level below recommended range, but not critical
NORMAL, # Within normal range, no need for driver action
HIGH, # Level above recommended range, but not critical
CRITICALLY_HIGH # Critically high, immediate action required
]
description: Engine oil level.

Expand Down
8 changes: 4 additions & 4 deletions spec/Powertrain/FuelSystem.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
FuelType:
datatype: string
type: attribute
allowed: [ "unknown", "gasoline", "diesel", "electric", "hybrid", "E85", "CNG", "LPG" ]
default: "unknown"
allowed: [UNKNOWN, GASOLINE, DIESEL, ELECTRIC, HYBRID, E85, CNG, LPG]
default: UNKNOWN
description: Defines the fuel type of the vehicle.

HybridType:
datatype: string
type: attribute
allowed: [ "unknown", "not_applicable", "stop_start", "belt_ISG", "CIMG", "PHEV" ]
default: "unknown"
allowed: [UNKNOWN, NOT_APPLICABLE, STOP_START, BELT_ISG, CIMG, PHEV]
default: UNKNOWN
description: Defines the hybrid type of the vehicle.

TankCapacity:
Expand Down
12 changes: 6 additions & 6 deletions spec/Powertrain/Transmission.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
Type:
datatype: string
type: attribute
allowed: [ "unknown", "sequential", "H", "automatic", "DSG", "CVT" ]
default: "unknown"
allowed: [UNKNOWN, SEQUENTIAL, H, AUTOMATIC, DSG, CVT]
default: UNKNOWN
description: Transmission type.


Expand All @@ -31,8 +31,8 @@ GearCount:
DriveType:
datatype: string
type: attribute
allowed: [ "unknown", "forward wheel drive", "rear wheel drive", "all wheel drive" ]
default: "unknown"
allowed: [UNKNOWN, FORWARD_WHEEL_DRIVE, REAR_WHEEL_DRIVE, ALL_WHEEL_DRIVE]
default: UNKNOWN
description: Drive type.


Expand Down Expand Up @@ -93,7 +93,7 @@ IsElectricalPowertrainEngaged:
PerformanceMode:
datatype: string
type: actuator
allowed: [ "normal", "sport", "economy", "snow", "rain" ]
allowed: [NORMAL, SPORT, ECONOMY, SNOW, RAIN]
description: Current gearbox performance mode.


Expand All @@ -103,7 +103,7 @@ PerformanceMode:
GearChangeMode:
datatype: string
type: actuator
allowed: [ "manual", "automatic" ]
allowed: [MANUAL, AUTOMATIC]
description: Is the gearbox in automatic or manual (paddle) mode.


Expand Down
12 changes: 6 additions & 6 deletions spec/Vehicle/Vehicle.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,12 @@ LowVoltageSystemState:
datatype: string
type: sensor
allowed: [
"UNDEFINED", # State of low voltage system not known
"LOCK", # Low voltage system off, steering lock or equivalent engaged
"OFF", # Low voltage system off, steering lock or equivalent not engaged
"ACC", # Vehicle Accessories on/living
"ON", # Engine start enabled (e.g. ignition on, diesel pre-heating, electrical drive released)
"START" # Engine starter relay closed (not applicable for electrical vehicles)
UNDEFINED, # State of low voltage system not known
LOCK, # Low voltage system off, steering lock or equivalent engaged
OFF, # Low voltage system off, steering lock or equivalent not engaged
ACC, # Vehicle Accessories on/living
ON, # Engine start enabled (e.g. ignition on, diesel pre-heating, electrical drive released)
START # Engine starter relay closed (not applicable for electrical vehicles)
]
description: State of the supply voltage of the control units (usually 12V).

Expand Down

0 comments on commit 72e3db6

Please sign in to comment.