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;
458 * \brief Must return the defrost status of all windows equiped with defrosters. This will return a dictionary of DefrostDictionary that represents
459 * \brief each window and its defrost status.
461 attribute DefrostDictionary defrost;
463 /** SteeringWheelHeater
464 * \brief Must return air recirculation on (true) / off (false).
466 attribute boolean steeringWheelHeater;
469 * \brief Must return seat heater status: on (true) / off (false).
471 attribute boolean seatHeater;
474 * \brief Must return seat heater status: on (true) / off (false).
476 attribute boolean seatCooler;
480 interface WindowStatus : VehiclePropertyType {
481 const unsigned short WINDOWLOCATION_DRIVER= 0;
482 const unsigned short WINDOWLOCATION_PASSENGER = 1;
483 const unsigned short WINDOWLOCATION_LEFTREAR = 2;
484 const unsigned short WINDOWLOCATION_RIGHTREAR = 3;
485 const unsigned short WINDOWLOCATION_REAR = 4;
488 * \brief Must return window status for each window location. object returned is a
489 * dictionary { unsigned short windowlocation, unsigned short percentage opened }
491 attribute object WindowStatus;
495 interface Sunroof : VehiclePropertyType {
498 * \brief Must return window status for sunroof openness percentage.
500 attribute unsigned short openness;
503 * \brief Must return tilt status for sunroof percentage.
505 attribute unsigned short tilt;
509 interface ConvertibleRoof : VehiclePropertyType {
512 * \brief Must return window status for sunroof openness percentage.
514 attribute unsigned short openness;
518 interface VehicleId : VehiclePropertyType {
521 * \brief MUST return World Manufacturer Identifier (WMI)
522 * WMI is defined by SAE ISO 3780:2009. 3 characters.
524 attribute DOMString WMI;
527 * \brief MUST return Vehicle Identification Number (VIN) as defined by ISO 3779. 17 characters.
529 attribute DOMString VIN;
533 interface Size : VehiclePropertyType {
536 * \brief MUST return width of vehicle in mm
538 attribute unsigned long width;
541 * \brief MUST return height of vehicle in mm
543 attribute unsigned long height;
546 * \brief MUST return length of vehicle in mm
548 attribute unsigned long length;
552 interface FuelInfo : VehiclePropertyType {
553 const unsigned short FUELTYPE_GASOLINE = 0;
554 const unsigned short FUELTYPE_HIGH_OCTANE= 1;
555 const unsigned short FUELTYPE_DIESEL = 2;
556 const unsigned short FUELTYPE_ELECTRIC = 3;
557 const unsigned short FUELTYPE_HYDROGEN = 4;
558 const unsigned short REFUELPOSITION_LEFT = 0;
559 const unsigned short REFUELPOSITION_RIGHT= 1;
560 const unsigned short REFUELPOSITION_FRONT = 2;
561 const unsigned short REFUELPOSITION_REAR = 3;
564 * \brief MUST return type of fuel. integer 0-4 (see
566 attribute unsigned short type;
569 * \brief MUST return position of refuling (see
571 attribute unsigned short refuelPosition;
575 interface VehicleType : VehiclePropertyType {
576 const unsigned short VEHICLETYPE_SEDAN = 0;
577 const unsigned short VEHICLETYPE_COUPE= 1;
578 const unsigned short VEHICLETYPE_CABRIOLE = 2;
579 const unsigned short VEHICLETYPE_ROADSTER = 3;
580 const unsigned short VEHICLETYPE_SUV = 4;
581 const unsigned short VEHICLETYPE_TRUCK = 5;
584 * \brief MUST return type of Vehicle. Integer 0-5 (see
586 attribute unsigned short type;
590 interface Doors : VehiclePropertyType {
593 * \brief MUST return Number of doors in each row. The index represents the row. Position '0'
594 * represents the first row, '1' the second row etc.
595 * Example a common mini-van may have Doors[0] = 2 doors,
596 * Doors[1] = 1 (side door), Doors[2] = 1 (trunk).
598 attribute sequence<unsigned short> doorsPerRow;
602 interface TransmissionGearType : VehiclePropertyType {
603 const unsigned short TRANSMISSIONGEARTYPE_AUTO=0;
604 const unsigned short TRANSMISSIONGEARTYPE_MANUAL=1;
605 const unsigned short TRANSMISSIONGEARTYPE_CV=2;
607 /** TransmissionGearType
608 * \brief MUST return transmission gear type of either Automatic, Manual or Constant Variable (CV). See
610 attribute unsigned short transmissionGearType;
614 interface WheelInformation : VehiclePropertyType {
617 * \brief MUST return Radius of Front Wheel(s) in mm.
619 attribute unsigned short frontWheelRadius;
622 * \brief MUST return Radius of Rear Wheel(s) in mm.
624 attribute unsigned short rearWheelRadius;
627 * \brief MUST return Wheel Track in mm.
629 attribute unsigned long wheelTrack;
632 * \brief MUST return Antilock Brake System status: on = true, off = false.
634 attribute boolean ABS;
638 interface Odometer : VehiclePropertyType {
641 * \brief MUST return Distance traveled in km
643 attribute unsigned long odometer;
647 interface Fluid : VehiclePropertyType {
650 * \brief MUST return Transmission fluid level percentage. 0-100.
652 attribute unsigned short transmission;
655 * \brief MUST return Brake fluid level percentage. 0-100.
657 attribute unsigned short brake;
660 * \brief MUST return Washer fluid level percentage. 0-100.
662 attribute unsigned short washer;
666 interface Battery : VehiclePropertyType {
669 * \brief MUST return battery voltage.
671 attribute double voltage;
674 * \brief MUST return battery current in Amperes
676 attribute double current;
680 interface TirePressure : VehiclePropertyType {
683 * \brief MUST return left front tire pressure in kPa.
685 attribute double leftFront;
688 * \brief MUST return right front tire pressure in kPa.
690 attribute double rightFront;
693 * \brief MUST return left rear tire pressure in kPa.
695 attribute double leftRear;
698 * \brief MUST return right rear tire pressure in kPa.
700 attribute double rightRear;
704 interface TireTemperature : VehiclePropertyType {
707 * \brief MUST return left front tire temperature in Celcius.
709 attribute double leftFront;
712 * \brief MUST return right front tire temperature in Celcius.
714 attribute double rightFront;
717 * \brief MUST return left rear tire temperature in Celcius.
719 attribute double leftRear;
722 * \brief MUST return right rear tire temperature in Celcius.
724 attribute double rightRear;
728 interface SecurityAlert : VehiclePropertyType {
733 attribute boolean securityAlert;
737 interface ParkingBrake : VehiclePropertyType {
740 * must return status of parking brake: Engaged = true, Disengaged = false.
742 attribute boolean parkingBrake;
746 interface ParkingLight : VehiclePropertyType {
749 * must return status of parking light: Engaged = true, Disengaged = false.
751 attribute boolean parkingLight;
755 interface HazardLight : VehiclePropertyType {
758 * must return status of hazard light: Engaged = true, Disengaged = false.
760 attribute boolean hazardLight;
764 interface AntilockBrakingSystem : VehiclePropertyType {
766 /** AntilockBrakingSystem
767 * \brief MUST return whether Antilock Braking System is Idle (false) or Engaged (true)
769 attribute boolean antilockBrakingSystem;
773 interface TractionControlSystem : VehiclePropertyType {
775 /** TractionControlSystem
776 * \brief MUST return whether Traction Control System is Off (false) or On (true)
778 attribute boolean tractionControlSystem;
782 interface VehicleTopSpeedLimit : VehiclePropertyType {
784 /** VehicleTopSpeedLimit
785 * \brief MUST returns top rated speed in km/h. 0 = no limit
787 attribute unsigned short vehicleTopSpeedLimit;
791 interface AirbagStatus : VehiclePropertyType {
792 const unsigned short AIRBAGLOCATION_DRIVER = 0;
793 const unsigned short AIRBAGLOCATION_PASSENGER= 1;
794 const unsigned short AIRBAGLOCATION_LEFTSIDE = 2;
795 const unsigned short AIRBAGLOCATION_RIGHTSIDE = 3;
796 const unsigned short AIRBAGSTATUS_INACTIVE = 0;
797 const unsigned short AIRBAGSTATUS_ACTIVE = 1;
798 const unsigned short AIRBAGSTATUS_DEPLOYED = 2;
801 * \brief MUST returns a dictionary of Airbag (byte) and Status (byte) (see
803 attribute object airbagStatus;
807 interface DoorStatus : VehiclePropertyType {
808 const unsigned short DOORLOCATION_DRIVER= 0;
809 const unsigned short DOORLOCATION_PASSENGER = 1;
810 const unsigned short DOORLOCATION_LEFTREAR = 2;
811 const unsigned short DOORLOCATION_RIGHTREAR = 3;
812 const unsigned short DOORLOCATION_TRUNK = 4;
813 const unsigned short DOORLOCATION_FUELCAP = 5;
814 const unsigned short DOORLOCATION_HOOD = 6;
815 const unsigned short DOORSTATUS_CLOSED = 0;
816 const unsigned short DOORSTATUS_OPEN = 1;
817 const unsigned short DOORSTATUS_AJAR = 2;
820 * \brief MUST returns dictionary of Door (byte) and Status (byte). See
822 attribute object doorStatus;
825 * \brief MUST returns dictionary of Door (byte) and Status (bool locked = true, unlocked = false). See
827 attribute object doorLockStatus;
830 * \brief MUST returns Child lock status of rear doors. active = true, inactive = false.
831 * Setting this to 'true' will prevent the rear doors from being opened
834 attribute boolean childLockStatus;
838 interface SeatBeltStatus : VehiclePropertyType {
839 const unsigned short SEATBELTLOCATION_DRIVER= 0;
840 const unsigned short SEATBELTLOCATION_MIDDLEFRONT = 1;
841 const unsigned short SEATBELTLOCATION_PASSENGER = 2;
842 const unsigned short SEATBELTLOCATION_LEFTREAR = 3;
843 const unsigned short SEATBELTLOCATION_MIDDLEREAR = 4;
844 const unsigned short SEATBELTLOCATION_RIGHTREAR = 5;
847 * \brief MUST returns dictionary of Seat Belt (byte, see SEATBELTLOCATION) and Status (bool: Fasten = true, Unfastened = false)
849 attribute object seatBeltStatus;
853 interface OccupantStatus : VehiclePropertyType {
854 const unsigned short OCCUPANTLOCATION_DRIVER = 0;
855 const unsigned short OCCUPANTLOCATION_FRONTMIDDLE = 1;
856 const unsigned short OCCUPANTLOCATION_PASSENGER= 2;
857 const unsigned short OCCUPANTLOCATION_LEFTREAR = 3;
858 const unsigned short OCCUPANTLOCATION_MIDDLEREAR = 4;
859 const unsigned short OCCUPANTLOCATION_RIGHTREAR = 5;
860 const unsigned short OCCUPANTSTATUS_VACANT = 0;
861 const unsigned short OCCUPANTSTATUS_CHILD = 1;
862 const unsigned short OCCUPANTSTATUS_ADULT = 2;
865 * \brief MUST returns dictionary of Occupant (byte see OCCUPANTLOCATION) and Status (byte, see
867 attribute object occupantStatus;
871 interface ObstacleDistance : VehiclePropertyType {
872 const unsigned short DISTANCESENSORLOCATION_LEFTFRONT = 0;
873 const unsigned short DISTANCESENSORLOCATION_RIGHTFRONT = 1;
874 const unsigned short DISTANCESENSORLOCATION_LEFTREAR = 2;
875 const unsigned short DISTANCESENSORLOCATION_RIGHTREAR = 3;
876 const unsigned short DISTANCESENSORLOCATION_LEFTBLINDSPOT = 4;
877 const unsigned short DISTANCESENSORLOCATION_RIGHTBLINDSPOT = 5;
880 * \brief MUST returns dictionary of Distance Sensor (byte, see DISTANCESENSORLOCATION) and distance (double) in m.
882 attribute object obstacleDistance;