6 \def-api-feature http://tizen.org/api/vehicle
7 \brief Allows access to the vehicle API
14 interface VehicleManagerObject {
15 readonly attribute Vehicle vehicle;
17 Tizen implements VehicleManagerObject;
21 interface VehiclePropertyType: Event {
23 * \brief time at which the vehicle generated the property
25 attribute DOMTimeStamp time;
27 attribute DOMString source;
31 interface VehiclePropertyError {
32 const unsigned short PERMISSION_DENIED = 1;
33 const unsigned short PROPERTY_UNAVAILABLE = 2;
34 const unsigned short TIMEOUT = 3;
35 const unsigned short UNKNOWN = 10;
38 * MUST return error code.
40 attribute unsigned short code;
43 * MUST return error message
45 attribute DOMString message;
48 callback VehiclePropertyCallback = void (VehiclePropertyType value);
50 callback VehiclePropertyErrorCallback = void (VehiclePropertyError error);
52 callback VehiclePropertyListCallback = void (sequence<VehiclePropertyType> values);
54 callback SupportedPropertiesCallback = void (sequence<DOMString> properties);
60 const unsigned short ZONE_None = 0;
61 const unsigned short ZONE_Front = 1;
62 const unsigned short ZONE_Middle = 0x10;
63 const unsigned short ZONE_Right = 0x100;
64 const unsigned short ZONE_Left = 0x1000;
65 const unsigned short ZONE_Rear = 0x10000;
66 const unsigned short ZONE_Center = 0x10000;
69 * \brief returns supported object types
71 sequence<DOMString> supported();
74 * \brief fetch the current value for 'objectType'.
75 * \param objectType is the requested property to be retrieved.
76 * \param zone specify the zone in which this object type is in
77 * \return object representing the requested 'objectType'
79 any get(DOMString objectType, optional short zone);
81 /** \brief subscribe to the given property and get callbacks when it changes
82 * \param objectType property to set
83 * \param successCallback callback will be called when the "objectType" changes
84 * \param errorCallback callback if error has been called.
87 void subscribe(DOMString objectType, VehiclePropertyCallback successCallback, optional unsigned short zone, optional VehiclePropertyErrorCallback errorCallback);
90 * \brief set the given objectType to value
91 * \param objectType object type to set
92 * \param value value to set, should contain zone information ie "zone" : 0
93 * \param errorCallback callback if error has been called.
95 void set(DOMString objectType, VehiclePropertyType value, optional VehiclePropertyErrorCallback errorCallback);
98 * \brief get values for a given objectType within a certain past time period between 'startTime' and 'endTime'
99 * \param objectType object type to request
100 * \param zone in which the objectType is located or 0 if no zone.
101 * \param startTime starting period of time.
102 * \param endTime ending period of time.
103 * \param successCallback Callback with the result of the method call
104 * \param errorCallback Callback if an error has occurred.
106 void getHistory(DOMString objectType, unsigned short zone, Date startTime, Date endTime, VehiclePropertyListCallback successCallback, optional VehiclePropertyErrorCallback errorCallback);
108 sequence<unsigned integer> listZones(DOMString objectType);
112 interface VehicleSpeed : VehiclePropertyType {
115 * \brief Must return Vehicle Speed in kilometers per hour.
117 attribute unsigned long vehicleSpeed;
121 interface EngineSpeed : VehiclePropertyType {
124 * \brief Must return Engine Speed in rotations per minute.
126 attribute unsigned long engineSpeed;
130 interface VehiclePowerMode : VehiclePropertyType {
131 const unsigned short VEHICLEPOWERMODE_OFF = 0;
132 const unsigned short VEHICLEPOWERMODE_ACCESSORY1 = 1;
133 const unsigned short VEHICLEPOWERMODE_ACCESSORY2 = 2;
134 const unsigned short VEHICLEPOWERMODE_RUN = 3;
137 * \brief Must return Vehicle Power mode (see VEHICLEPOWERMODE)
139 attribute octet vehiclePowerMode;
143 interface TripMeter : VehiclePropertyType {
146 * \brief Must return trip meters. Changing any items in the array will reset the item's value to '0'.
148 attribute sequence<unsigned long> tripMeters;
152 interface Acceleration : VehiclePropertyType {
155 * \brief Must return acceleration on the "X" axis as 1/1000 G (gravitational force).
157 attribute unsigned long x;
160 * \brief Must return acceleration on the "Y" axis as 1/1000 G (gravitational force).
162 attribute unsigned long y;
165 * \brief Must return acceleration on the "Z" axis as 1/1000 G (gravitational force).
167 attribute unsigned long z;
171 interface Transmission : VehiclePropertyType {
172 const unsigned short TRANSMISSIONPOSITION_NEUTRAL = 0;
173 const unsigned short TRANSMISSIONPOSITION_FIRST = 1;
174 const unsigned short TRANSMISSIONPOSITION_SECOND = 2;
175 const unsigned short TRANSMISSIONPOSITION_THIRD = 3;
176 const unsigned short TRANSMISSIONPOSITION_FORTH = 4;
177 const unsigned short TRANSMISSIONPOSITION_FIFTH = 5;
178 const unsigned short TRANSMISSIONPOSITION_SIXTH = 6;
179 const unsigned short TRANSMISSIONPOSITION_SEVENTH = 7;
180 const unsigned short TRANSMISSIONPOSITION_EIGHTH = 8;
181 const unsigned short TRANSMISSIONPOSITION_NINTH = 9;
182 const unsigned short TRANSMISSIONPOSITION_TENTH = 10;
183 const unsigned short TRANSMISSIONPOSITION_CVT = 64;
184 const unsigned short TRANSMISSIONPOSITION_REVERSE = 128;
185 const unsigned short TRANSMISSIONPOSITION_PARK = 255;
186 const unsigned short TRANSMISSIONMODE_NORMAL = 0;
187 const unsigned short TRANSMISSIONMODE_SPORT = 1;
188 const unsigned short TRANSMISSIONMODE_ECONOMY = 2;
189 const unsigned short TRANSMISSIONMODE_OEMCUSTOM1 = 3;
190 const unsigned short TRANSMISSIONMODE_OEMCUSTOM2 = 4;
193 * \brief Must return transmission gear position (see TRANSMISSIONPOSITION)
195 attribute octet gearPosition;
198 * \brief Must return transmission Mode (see
200 attribute octet mode;
204 interface CruiseControlStatus : VehiclePropertyType {
207 * \brief Must return whether or not the Cruise Control system is active (true) or inactive (false)
209 attribute boolean activated;
212 * \brief Must return target Cruise Control speed in kilometers per hour (kph).
214 attribute unsigned short speed;
218 interface WheelBrake : VehiclePropertyType {
221 * \brief Must return Wheel Brake status: Engaged = true, disengaged = false
223 attribute boolean engaged;
227 interface LightStatus : VehiclePropertyType {
230 * \brief Must return headlight status: on = true, off = false.
232 attribute boolean head;
235 * \brief Must return right turn signal status: on = true, off = false.
237 attribute boolean rightTurn;
240 * \brief Must return left turn signal status: on = true, off = false.
242 attribute boolean leftTurn;
245 * \brief Must return brake signal light status: on = true, off = false.
247 attribute boolean brake;
250 * \brief Must return fog light status: on = true, off = false.
252 attribute boolean fog;
255 * \brief Must return hazard light status: on = true, off = false.
257 attribute boolean hazard;
260 * \brief Must return parking light status: on = true, off = false.
262 attribute boolean parking;
265 * \brief Must return high beam status: on = true, off = false.
267 attribute boolean highBeam;
271 interface InteriorLightStatus : VehiclePropertyType {
274 * \brief Must return passenger interior light status: on = true, off = false
276 attribute boolean passenger;
279 * \brief Must return driver interior light status: on = true, off = false
281 attribute boolean driver;
284 * \brief Must return center interior light status: on = true, off = false
286 attribute boolean center;
290 interface Horn : VehiclePropertyType {
293 * \brief Must return horn status: on = true, off = false
295 attribute boolean on;
299 interface Fuel : VehiclePropertyType {
302 * \brief Must return fuel level as a percentage of fullness.
304 attribute unsigned short level;
307 * \brief Must return estimated fuel range in kilometers.
309 attribute unsigned short range;
311 /** InstantConsumption
312 * \brief Must return instant fuel consumption in milliliters of fuel per second.
314 attribute unsigned short instantConsumption;
317 * \brief Must return instant fuel 'economy' in kilometers per liter of fuel.
319 attribute unsigned short instantEconomy;
322 * \brief Must return average fuel 'economy' in kilometers per liter of fuel since last reset. Setting this to any value should reset the counter to '0'
324 attribute unsigned short averageEconomy;
328 interface EngineOil : VehiclePropertyType {
331 * \brief Must return remaining engine oil as percentage of fullness.
333 attribute unsigned short remaining;
336 * \brief Must return Engine Oil Temperature in Celcius.
338 attribute long temperature;
341 * \brief Must return Engine Oil Pressure in kPa.
343 attribute unsigned short pressure;
347 interface Location : VehiclePropertyType {
350 * \brief Must return latitude in Deg.Min (-180, +180)
352 attribute double latitude;
355 * \brief Must return longitude in Deg.Min (-90, +90)
357 attribute double longitude;
360 * \brief Must return altitude in meters above sea-level (0).
362 attribute double altitude;
365 * \brief Must return direction in Degrees (0-360)
367 attribute unsigned short direction;
371 interface ExteriorBrightness : VehiclePropertyType {
373 /** ExteriorBrightness
374 * \brief Must return the brightness outside the vehicle in lux.
376 attribute unsigned long exteriorBrightness;
380 interface Temperature : VehiclePropertyType {
383 * \brief Must return the temperature of the interior of the vehicle in celcius.
385 attribute short interior;
388 * \brief Must return the temperature of the exterior of the vehicle in celcius.
390 attribute short exterior;
394 interface RainSensor : VehiclePropertyType {
397 * \brief Must return level of rain intensity 0: No Rain - 10: Heaviest Rain.
399 attribute unsigned short rainSensor;
403 interface WindshieldWiper : VehiclePropertyType {
404 const unsigned short WIPERSPEED_OFF = 0;
405 const unsigned short WIPERSPEED_SLOWEST= 1;
406 const unsigned short WIPERSPEED_FASTEST = 5;
407 const unsigned short WIPERSPEED_AUTO = 10;
410 * \brief Must return Level of windshield whiper speed (see WIPERSPEED)
412 attribute unsigned short windshieldWiper;
415 dictionary DefrostDictionary {
416 unsigned short window;
421 interface HVAC : VehiclePropertyType {
422 const unsigned short AIRFLOWDIRECTION_FRONTPANEL = 0;
423 const unsigned short AIRFLOWDIRECTION_FLOORDUCT= 1;
424 const unsigned short AIRFLOWDIRECTION_FRONT = 0x02;
425 const unsigned short AIRFLOWDIRECTION_DEFROSTER = 0x04;
428 * \brief Must return airflow direction. See
430 attribute unsigned short airflowDirection;
433 * \brief Must return speed of the fan (0-7)
435 attribute unsigned short fanSpeed;
437 /** TargetTemperature
438 * \brief Must return target desired temperature in celcius.
440 attribute unsigned short targetTemperature;
443 * \brief Must return air conditioning on (true) / off (false).
445 attribute boolean airConditioning;
448 * \brief Must return air recirculation on (true) / off (false).
450 attribute boolean airRecirculation;
453 * \brief Must return heater on (true) / off (false).
455 attribute boolean heater;
457 /** SteeringWheelHeater
458 * \brief Must return air recirculation on (true) / off (false).
460 attribute boolean steeringWheelHeater;
463 * \brief Must return seat heater status: on (true) / off (false).
465 attribute boolean seatHeater;
468 * \brief Must return seat heater status: on (true) / off (false).
470 attribute boolean seatCooler;
474 interface WindowStatus : VehiclePropertyType {
475 const unsigned short WINDOWLOCATION_DRIVER= 0;
476 const unsigned short WINDOWLOCATION_PASSENGER = 1;
477 const unsigned short WINDOWLOCATION_LEFTREAR = 2;
478 const unsigned short WINDOWLOCATION_RIGHTREAR = 3;
479 const unsigned short WINDOWLOCATION_REAR = 4;
482 * \brief Must return window openness percentage (100% fully open, 0% fully closed)
483 * for the window location see "zone" attribute
485 attribute unsigned short openness;
488 * \brief Must return the defroster status of the window. On = true, Off = false.
490 attribute boolean defrost;
494 interface Sunroof : VehiclePropertyType {
497 * \brief Must return window status for sunroof openness percentage.
499 attribute unsigned short openness;
502 * \brief Must return tilt status for sunroof percentage.
504 attribute unsigned short tilt;
508 interface ConvertibleRoof : VehiclePropertyType {
511 * \brief Must return window status for sunroof openness percentage.
513 attribute unsigned short openness;
517 interface VehicleId : VehiclePropertyType {
520 * \brief MUST return World Manufacturer Identifier (WMI)
521 * WMI is defined by SAE ISO 3780:2009. 3 characters.
523 attribute DOMString WMI;
526 * \brief MUST return Vehicle Identification Number (VIN) as defined by ISO 3779. 17 characters.
528 attribute DOMString VIN;
532 interface Size : VehiclePropertyType {
535 * \brief MUST return width of vehicle in mm
537 attribute unsigned long width;
540 * \brief MUST return height of vehicle in mm
542 attribute unsigned long height;
545 * \brief MUST return length of vehicle in mm
547 attribute unsigned long length;
551 interface FuelInfo : VehiclePropertyType {
552 const unsigned short FUELTYPE_GASOLINE = 0;
553 const unsigned short FUELTYPE_HIGH_OCTANE= 1;
554 const unsigned short FUELTYPE_DIESEL = 2;
555 const unsigned short FUELTYPE_ELECTRIC = 3;
556 const unsigned short FUELTYPE_HYDROGEN = 4;
557 const unsigned short REFUELPOSITION_LEFT = 0;
558 const unsigned short REFUELPOSITION_RIGHT= 1;
559 const unsigned short REFUELPOSITION_FRONT = 2;
560 const unsigned short REFUELPOSITION_REAR = 3;
563 * \brief MUST return type of fuel. integer 0-4 (see
565 attribute unsigned short type;
568 * \brief MUST return position of refuling (see
570 attribute unsigned short refuelPosition;
574 interface VehicleType : VehiclePropertyType {
575 const unsigned short VEHICLETYPE_SEDAN = 0;
576 const unsigned short VEHICLETYPE_COUPE= 1;
577 const unsigned short VEHICLETYPE_CABRIOLE = 2;
578 const unsigned short VEHICLETYPE_ROADSTER = 3;
579 const unsigned short VEHICLETYPE_SUV = 4;
580 const unsigned short VEHICLETYPE_TRUCK = 5;
583 * \brief MUST return type of Vehicle. Integer 0-5 (see
585 attribute unsigned short type;
589 interface Doors : VehiclePropertyType {
592 * \brief MUST return Number of doors in each row. The index represents the row. Position '0'
593 * represents the first row, '1' the second row etc.
594 * Example a common mini-van may have Doors[0] = 2 doors,
595 * Doors[1] = 1 (side door), Doors[2] = 1 (trunk).
597 attribute sequence<unsigned short> doorsPerRow;
601 interface TransmissionGearType : VehiclePropertyType {
602 const unsigned short TRANSMISSIONGEARTYPE_AUTO=0;
603 const unsigned short TRANSMISSIONGEARTYPE_MANUAL=1;
604 const unsigned short TRANSMISSIONGEARTYPE_CV=2;
606 /** TransmissionGearType
607 * \brief MUST return transmission gear type of either Automatic, Manual or Constant Variable (CV). See
609 attribute unsigned short transmissionGearType;
613 interface WheelInformation : VehiclePropertyType {
616 * \brief MUST return Radius of Front Wheel(s) in mm.
618 attribute unsigned short frontWheelRadius;
621 * \brief MUST return Radius of Rear Wheel(s) in mm.
623 attribute unsigned short rearWheelRadius;
626 * \brief MUST return Wheel Track in mm.
628 attribute unsigned long wheelTrack;
631 * \brief MUST return Antilock Brake System status: on = true, off = false.
633 attribute boolean ABS;
637 interface Odometer : VehiclePropertyType {
640 * \brief MUST return Distance traveled in km
642 attribute unsigned long odometer;
646 interface Fluid : VehiclePropertyType {
649 * \brief MUST return Transmission fluid level percentage. 0-100.
651 attribute unsigned short transmission;
654 * \brief MUST return Brake fluid level percentage. 0-100.
656 attribute unsigned short brake;
659 * \brief MUST return Washer fluid level percentage. 0-100.
661 attribute unsigned short washer;
665 interface Battery : VehiclePropertyType {
668 * \brief MUST return battery voltage.
670 attribute double voltage;
673 * \brief MUST return battery current in Amperes
675 attribute double current;
679 interface TirePressure : VehiclePropertyType {
682 * \brief MUST return left front tire pressure in kPa.
684 attribute double leftFront;
687 * \brief MUST return right front tire pressure in kPa.
689 attribute double rightFront;
692 * \brief MUST return left rear tire pressure in kPa.
694 attribute double leftRear;
697 * \brief MUST return right rear tire pressure in kPa.
699 attribute double rightRear;
703 interface TireTemperature : VehiclePropertyType {
706 * \brief MUST return left front tire temperature in Celcius.
708 attribute double leftFront;
711 * \brief MUST return right front tire temperature in Celcius.
713 attribute double rightFront;
716 * \brief MUST return left rear tire temperature in Celcius.
718 attribute double leftRear;
721 * \brief MUST return right rear tire temperature in Celcius.
723 attribute double rightRear;
727 interface SecurityAlert : VehiclePropertyType {
732 attribute boolean securityAlert;
736 interface ParkingBrake : VehiclePropertyType {
739 * must return status of parking brake: Engaged = true, Disengaged = false.
741 attribute boolean parkingBrake;
745 interface ParkingLight : VehiclePropertyType {
748 * must return status of parking light: Engaged = true, Disengaged = false.
750 attribute boolean parkingLight;
754 interface HazardLight : VehiclePropertyType {
757 * must return status of hazard light: Engaged = true, Disengaged = false.
759 attribute boolean hazardLight;
763 interface AntilockBrakingSystem : VehiclePropertyType {
765 /** AntilockBrakingSystem
766 * \brief MUST return whether Antilock Braking System is Idle (false) or Engaged (true)
768 attribute boolean antilockBrakingSystem;
772 interface TractionControlSystem : VehiclePropertyType {
774 /** TractionControlSystem
775 * \brief MUST return whether Traction Control System is Off (false) or On (true)
777 attribute boolean tractionControlSystem;
781 interface VehicleTopSpeedLimit : VehiclePropertyType {
783 /** VehicleTopSpeedLimit
784 * \brief MUST returns top rated speed in km/h. 0 = no limit
786 attribute unsigned short vehicleTopSpeedLimit;
790 interface AirbagStatus : VehiclePropertyType {
791 const unsigned short AIRBAGSTATUS_INACTIVE = 0;
792 const unsigned short AIRBAGSTATUS_ACTIVE = 1;
793 const unsigned short AIRBAGSTATUS_DEPLOYED = 2;
796 * \brief MUST return Airbag deployment status (see AIRBAGSTATUS*)
798 attribute unsigned short airbagStatus;
802 interface DoorStatus : VehiclePropertyType {
803 const unsigned short DOORSTATUS_CLOSED = 0;
804 const unsigned short DOORSTATUS_OPEN = 1;
805 const unsigned short DOORSTATUS_AJAR = 2;
808 * \brief MUST returns Door status (byte). See DOORSTATUS_*
810 attribute unsigned short doorStatus;
813 * \brief MUST returns Door status (bool locked = true, unlocked = false).
815 attribute boolean doorLockStatus;
818 * \brief MUST returns Child lock status of rear doors. active = true, inactive = false.
819 * Setting this to 'true' will prevent the rear doors from being opened
822 attribute boolean childLockStatus;
826 interface SeatBeltStatus : VehiclePropertyType {
829 * \brief MUST return Seat Belt status (bool: Fasten = true, Unfastened = false)
831 attribute boolean seatBeltStatus;
835 interface OccupantStatus : VehiclePropertyType {
836 const unsigned short OCCUPANTSTATUS_VACANT = 0;
837 const unsigned short OCCUPANTSTATUS_CHILD = 1;
838 const unsigned short OCCUPANTSTATUS_ADULT = 2;
841 * \brief MUST returns Occupant status (byte, see OCCUPANTSTATUS)
843 attribute unsigned short occupantStatus;
847 interface ObstacleDistance : VehiclePropertyType {
848 const unsigned short DISTANCESENSORLOCATION_LEFTFRONT = 0;
849 const unsigned short DISTANCESENSORLOCATION_RIGHTFRONT = 1;
850 const unsigned short DISTANCESENSORLOCATION_LEFTREAR = 2;
851 const unsigned short DISTANCESENSORLOCATION_RIGHTREAR = 3;
852 const unsigned short DISTANCESENSORLOCATION_LEFTBLINDSPOT = 4;
853 const unsigned short DISTANCESENSORLOCATION_RIGHTBLINDSPOT = 5;
856 * \brief MUST returns Distance Sensor distance (Double) in m.
858 attribute double obstacleDistance;
862 interface NightMode : VehiclePropertyType {
865 * \brief MUST return whether or not the system is in NightMode or not. True = Night time, False = Day time
867 attribute boolean nightMode;
871 interface DrivingMode : VehiclePropertyType {
874 * \brief MUST return whether or not the system is in DrivingMode or not. 1 = Driving, 0 = Not Driving
876 attribute unsigned short drivingMode;