diff options
author | Kevron Rees <kevron_m_rees@linux.intel.com> | 2013-03-26 16:09:37 -0700 |
---|---|---|
committer | Kevron Rees <kevron_m_rees@linux.intel.com> | 2013-03-26 16:09:37 -0700 |
commit | b96b533e91e48429b2708c8344d0469d546d7ee6 (patch) | |
tree | 537547b67bb9f472974f63ba7a9f0a0cbbcf1871 | |
parent | aa46048f52bd0fd3e18561f5f7529b18fbf0f929 (diff) | |
download | automotive-message-broker-b96b533e91e48429b2708c8344d0469d546d7ee6.tar.gz |
some documentation tagging work
-rw-r--r-- | plugins/dbus/amb.idl | 177 | ||||
-rw-r--r-- | plugins/dbus/environmentproperties.h | 8 | ||||
-rw-r--r-- | plugins/dbus/fakeidlheader.h | 35 | ||||
-rw-r--r-- | plugins/dbus/maintenance.h | 8 | ||||
-rw-r--r-- | plugins/dbus/parking.h | 8 | ||||
-rw-r--r-- | plugins/dbus/runningstatus.h | 28 | ||||
-rw-r--r-- | plugins/dbus/vehicleinfo.h | 61 | ||||
-rw-r--r-- | plugins/websocketsink/websocketsinkmanager.cpp | 2 |
8 files changed, 250 insertions, 77 deletions
diff --git a/plugins/dbus/amb.idl b/plugins/dbus/amb.idl index 7b81b912..d84736d4 100644 --- a/plugins/dbus/amb.idl +++ b/plugins/dbus/amb.idl @@ -1,4 +1,10 @@ -TizenimplementsVehicleObject;**/ +Tizen implements VehicleObject; + +callback VehiclePropertyCallback = void (VehiclePropertyType value); + +callback VehiclePropertyErrorCallback = void (VehiclePropertyError error); + +callback VehiclePropertyListCallback = void (sequence<VehiclePropertyType> values); /** @@ -13,54 +19,54 @@ Details. module Vehicle { [NoInterfaceObject] -interface VehicleSpeed { +interface VehicleSpeed : VehiclePropertyType { readonly attribute unsigned short VehicleSpeed; }; [NoInterfaceObject] -interface EngineSpeed { +interface EngineSpeed : VehiclePropertyType { readonly attribute unsigned short EngineSpeed; }; [NoInterfaceObject] -interface VehiclePowerMode { +interface VehiclePowerMode : VehiclePropertyType { readonly attribute octet VehiclePowerMode; }; [NoInterfaceObject] -interface TripMeter { +interface TripMeter : VehiclePropertyType { attribute unsigned short TripMeterA; attribute unsigned short TripMeterB; attribute unsigned short TripMeterC; }; [NoInterfaceObject] -interface Acceleration { +interface Acceleration : VehiclePropertyType { readonly attribute unsigned short X; readonly attribute unsigned short Y; readonly attribute unsigned short Z; }; [NoInterfaceObject] -interface Transmission { +interface Transmission : VehiclePropertyType { readonly attribute octet ShiftPosition; readonly attribute octet GearPosition; readonly attribute octet Mode; }; [NoInterfaceObject] -interface CruiseControlStatus { +interface CruiseControlStatus : VehiclePropertyType { readonly attribute boolean Activated; readonly attribute unsigned short Speed; }; [NoInterfaceObject] -interface WheelBrake { +interface WheelBrake : VehiclePropertyType { readonly attribute boolean Engaged; }; [NoInterfaceObject] -interface LightStatus { +interface LightStatus : VehiclePropertyType { readonly attribute boolean Head; readonly attribute boolean RightTurn; readonly attribute boolean LeftTurn; @@ -72,19 +78,19 @@ interface LightStatus { }; [NoInterfaceObject] -interface InteriorLightStatus { +interface InteriorLightStatus : VehiclePropertyType { readonly attribute boolean Passenger; readonly attribute boolean Driver; readonly attribute boolean Center; }; [NoInterfaceObject] -interface Horn { +interface Horn : VehiclePropertyType { readonly attribute boolean On; }; [NoInterfaceObject] -interface Fuel { +interface Fuel : VehiclePropertyType { readonly attribute unsigned short Level; readonly attribute unsigned short Range; readonly attribute unsigned short InstantConsumption; @@ -93,14 +99,14 @@ interface Fuel { }; [NoInterfaceObject] -interface EngineOil { +interface EngineOil : VehiclePropertyType { readonly attribute unsigned short Remaining; readonly attribute long Temperature; readonly attribute unsigned short Pressure; }; [NoInterfaceObject] -interface Location { +interface Location : VehiclePropertyType { readonly attribute double Latitude; readonly attribute double Longitude; readonly attribute double Altitude; @@ -108,63 +114,142 @@ interface Location { }; [NoInterfaceObject] -interface ExteriorBrightness { +interface ExteriorBrightness : VehiclePropertyType { + + /** ExteriorBrightness + * Must return Exterior Brightness in lux. + **/ + readonly attribute unsigned long ExteriorBrightness; }; [NoInterfaceObject] -interface VehicleId { +interface VehicleId : VehiclePropertyType { + + /** WMI + * \brief MUST return World Manufacturer Identifier (WMI) + * WMI is defined by SAE ISO 3780:2009. 3 characters. + **/ readonly attribute DOMString WMI; + + /** VIN + * \brief MUST return Vehicle Identification Number (VIN) as defined by ISO 3779. 17 characters. + **/ readonly attribute DOMString VIN; }; [NoInterfaceObject] -interface Size { +interface Size : VehiclePropertyType { + + /** Width + * \brief MUST return width of vehicle in mm + **/ readonly attribute unsigned long Width; + + /** Height + * \brief MUST return height of vehicle in mm + **/ readonly attribute unsigned long Height; + + /** Length + * \brief MUST return length of vehicle in mm + **/ readonly attribute unsigned long Length; }; [NoInterfaceObject] -interface FuelInfo { +interface FuelInfo : VehiclePropertyType { + const unsigned short FUELTYPE_GASOLINE = 0; + const unsigned short FUELTYPE_HIGH_OCTANE= 1; + const unsigned short FUELTYPE_DIESEL = 2; + const unsigned short FUELTYPE_ELECTRIC = 3; + const unsigned short FUELTYPE_HYDROGEN = 4; + const unsigned short REFUELPOSITION_LEFT = 0; + const unsigned short REFUELPOSITION_RIGHT= 1; + const unsigned short REFUELPOSITION_FRONT = 2; + const unsigned short REFUELPOSITION_REAR = 3; + + /** Type + * \brief MUST return type of fuel. integer 0-4 (see + **/ readonly attribute unsigned short Type; + + /** RefuelPosition + * \brief MUST return position of refuling (see + **/ readonly attribute unsigned short RefuelPosition; }; [NoInterfaceObject] -interface VehicleType { +interface VehicleType : VehiclePropertyType { + const unsigned short VEHICLETYPE_SEDAN = 0; + const unsigned short VEHICLETYPE_COUPE= 1; + const unsigned short VEHICLETYPE_CABRIOLE = 2; + const unsigned short VEHICLETYPE_ROADSTER = 3; + const unsigned short VEHICLETYPE_SUV = 4; + const unsigned short VEHICLETYPE_TRUCK = 5; + + /** Type + * \brief MUST return type of Vehicle. Integer 0-5 (see + **/ readonly attribute unsigned short Type; }; [NoInterfaceObject] -interface Doors { +interface Doors : VehiclePropertyType { + + /** DoorsPerRow + * \brief MUST return Number of doors in each row. The index represents the row. Position '0' + * represents the first row, '1' the second row etc. + * Example a common mini-van may have Doors[0] = 2 doors, + * Doors[1] = 1 (side door), Doors[2] = 1 (trunk). + **/ readonly attribute sequence<unsigned short> DoorsPerRow; }; [NoInterfaceObject] -interface TransmissionGearType { +interface TransmissionGearType : VehiclePropertyType { + const unsigned short TRANSMISSIONGEARTYPE_AUTO=0; + const unsigned short TRANSMISSIONGEARTYPE_MANUAL=1; + const unsigned short TRANSMISSIONGEARTYPE_CV=2; + + /** TransmissionGearType + * \brief MUST return transmission gear type of either Automatic, Manual or Constant Variable (CV). See + **/ readonly attribute unsigned short TransmissionGearType; }; [NoInterfaceObject] -interface WheelInformation { +interface WheelInformation : VehiclePropertyType { + + /** FrontWheelRadius + * \brief MUST return Radius of Front Wheel(s) in mm. + **/ readonly attribute unsigned short FrontWheelRadius; + + /** RearWheelRadius + * \brief MUST return Radius of Rear Wheel(s) in mm. + **/ readonly attribute unsigned short RearWheelRadius; + + /** WheelTrack + * \brief MUST return Wheel Track in mm. + **/ readonly attribute unsigned long WheelTrack; }; [NoInterfaceObject] -interface Odometer { +interface Odometer : VehiclePropertyType { readonly attribute unsigned long Odometer; }; [NoInterfaceObject] -interface Battery { +interface Battery : VehiclePropertyType { readonly attribute double Voltage; readonly attribute double Current; }; [NoInterfaceObject] -interface TirePressure { +interface TirePressure : VehiclePropertyType { readonly attribute double LeftFront; readonly attribute double RightFront; readonly attribute double LeftRear; @@ -172,7 +257,7 @@ interface TirePressure { }; [NoInterfaceObject] -interface TireTemperature { +interface TireTemperature : VehiclePropertyType { readonly attribute double LeftFront; readonly attribute double RightFront; readonly attribute double LeftRear; @@ -180,42 +265,58 @@ interface TireTemperature { }; [NoInterfaceObject] -interface SecurityAlert { +interface SecurityAlert : VehiclePropertyType { readonly attribute boolean SecurityAlert; }; [NoInterfaceObject] -interface ParkingBrake { +interface ParkingBrake : VehiclePropertyType { readonly attribute boolean ParkingBrake; }; [NoInterfaceObject] -interface ParkingLight { +interface ParkingLight : VehiclePropertyType { readonly attribute boolean ParkingLight; }; [NoInterfaceObject] -interface HazardLight { +interface HazardLight : VehiclePropertyType { readonly attribute boolean HazardLight; }; [NoInterfaceObject] -interface VehicleObject { +interface VehicleObject { readonly attribute Vehicle ; }; [NoInterfaceObject] -interface VehiclePropertyType { - readonly attribute object value; +interface VehiclePropertyType { readonly attribute Date timeStamp; }; [NoInterfaceObject] -interface Vehicle { +interface VehiclePropertyError { + const unsigned short PERMISSION_DENIED = 1; + const unsigned short PROPERTY_UNAVAILABLE = 2; + const unsigned short TIMEOUT = 3; + + /** code + * MUST return error code. + **/ + readonly attribute unsigned short code; + + /** message + * MUST return error message + **/ + readonly attribute DOMString message; +}; + +[NoInterfaceObject] +interface Vehicle { sequence<DOMString> getSupported(); - object get(DOMString property); - void set(DOMString property, object value); - sequence<VehiclePropertyTypes> getHistory(DOMString type, Date startTime, Date endTime); + get(DOMString property, VehiclePropertyCallback successCallback, optional VehiclePropertyErrorCallback errorCallback); + set(DOMString property, VehiclePropertyType value, optional SuccessCallback successCallback, optional VehiclePropertyErrorCallback errorCallback); + getHistory(DOMString property, Date startTime, Date endTime, VehicleHistoryListCallback successCallback, VehiclePropertyErrorCallback errorCallback); }; }; diff --git a/plugins/dbus/environmentproperties.h b/plugins/dbus/environmentproperties.h index b510c0af..79d9fac4 100644 --- a/plugins/dbus/environmentproperties.h +++ b/plugins/dbus/environmentproperties.h @@ -5,13 +5,19 @@ #include "abstractdbusinterface.h" #include "abstractroutingengine.h" -/** @interface ExteriorBrightness **/ +/** @interface ExteriorBrightness : VehiclePropertyType **/ class ExteriorBrightnessProperty: public DBusSink { public: ExteriorBrightnessProperty(AbstractRoutingEngine* re, GDBusConnection* connection) :DBusSink("org.automotive.ExteriorBrightness","/org/automotive/environment/ExteriorBrightness", re, connection, map<string, string>()) { + /** + * @attributeName ExteriorBrightness + * @type unsigned long + * @access readonly + * @attributeComment \brief Must return the brightness outside the vehicle in lux. + */ wantProperty<uint16_t>(VehicleProperty::ExteriorBrightness,"ExteriorBrightness", "q", AbstractProperty::Read); supportedChanged(re->supported()); } diff --git a/plugins/dbus/fakeidlheader.h b/plugins/dbus/fakeidlheader.h index 40959f35..397d3e3d 100644 --- a/plugins/dbus/fakeidlheader.h +++ b/plugins/dbus/fakeidlheader.h @@ -22,20 +22,39 @@ /** @raw Tizen implements VehicleObject; **/ /** @interface VehiclePropertyType **/ -/** @attributeName value - * @type object - * @access readonly - * - * @attributeName timeStamp +/** @attributeName timeStamp * @type Date * @access readonly **/ +/** @raw callback VehiclePropertyCallback = void (VehiclePropertyType value); **/ + +/** @raw callback VehiclePropertyErrorCallback = void (VehiclePropertyError error); **/ + +/** @raw callback VehiclePropertyListCallback = void (sequence<VehiclePropertyType> values); **/ + +/** @interface VehiclePropertyError +* +* @enum const unsigned short PERMISSION_DENIED = 1; +* @enum const unsigned short PROPERTY_UNAVAILABLE = 2; +* @enum const unsigned short TIMEOUT = 3; +* +* @attributeName code +* @type unsigned short +* @access readonly +* @attributeComment MUST return error code. +* +* @attributeName message +* @type DOMString +* @access readonly +* @attributeComment MUST return error message +**/ + /** @interface Vehicle **/ /** @method sequence<DOMString> getSupported(); - * @method object get(DOMString property); - * @method void set(DOMString property, object value); - * @method sequence<VehiclePropertyTypes> getHistory(DOMString type, Date startTime, Date endTime); + * @method get(DOMString property, VehiclePropertyCallback successCallback, optional VehiclePropertyErrorCallback errorCallback); + * @method set(DOMString property, VehiclePropertyType value, optional SuccessCallback successCallback, optional VehiclePropertyErrorCallback errorCallback); + * @method getHistory(DOMString property, Date startTime, Date endTime, VehicleHistoryListCallback successCallback, VehiclePropertyErrorCallback errorCallback); **/ diff --git a/plugins/dbus/maintenance.h b/plugins/dbus/maintenance.h index f5e65330..ab32a881 100644 --- a/plugins/dbus/maintenance.h +++ b/plugins/dbus/maintenance.h @@ -6,7 +6,7 @@ #include "abstractdbusinterface.h" #include "abstractroutingengine.h" -/** @interface Odometer **/ +/** @interface Odometer : VehiclePropertyType **/ class OdometerProperty: public DBusSink { public: @@ -23,7 +23,7 @@ public: } }; -/** @interface Battery **/ +/** @interface Battery : VehiclePropertyType **/ class BatteryProperty: public DBusSink { public: @@ -45,7 +45,7 @@ public: } }; -/** @interface TirePressure **/ +/** @interface TirePressure : VehiclePropertyType **/ class TirePressureProperty: public DBusSink { public: @@ -79,7 +79,7 @@ public: } }; -/** @interface TireTemperature **/ +/** @interface TireTemperature : VehiclePropertyType **/ class TireTemperatureProperty: public DBusSink { public: diff --git a/plugins/dbus/parking.h b/plugins/dbus/parking.h index 18337f51..b438750a 100644 --- a/plugins/dbus/parking.h +++ b/plugins/dbus/parking.h @@ -6,7 +6,7 @@ #include "abstractdbusinterface.h" #include "abstractroutingengine.h" -/** @interface SecurityAlert **/ +/** @interface SecurityAlert : VehiclePropertyType **/ class SecurityAlertProperty: public DBusSink { public: @@ -24,7 +24,7 @@ public: } }; -/** @interface ParkingBrake **/ +/** @interface ParkingBrake : VehiclePropertyType **/ class ParkingBrakeProperty: public DBusSink { public: @@ -41,7 +41,7 @@ public: } }; -/** @interface ParkingLight **/ +/** @interface ParkingLight : VehiclePropertyType **/ class ParkingLightProperty: public DBusSink { public: @@ -58,7 +58,7 @@ public: } }; -/** @interface HazardLight **/ +/** @interface HazardLight : VehiclePropertyType **/ class HazardLightProperty: public DBusSink { public: diff --git a/plugins/dbus/runningstatus.h b/plugins/dbus/runningstatus.h index e48c7b4f..09dd7052 100644 --- a/plugins/dbus/runningstatus.h +++ b/plugins/dbus/runningstatus.h @@ -23,7 +23,7 @@ #include "abstractdbusinterface.h" #include "abstractroutingengine.h" -/** @interface VehicleSpeed **/ +/** @interface VehicleSpeed : VehiclePropertyType **/ class VehicleSpeedProperty: public DBusSink { public: @@ -41,7 +41,7 @@ public: }; -/** @interface EngineSpeed **/ +/** @interface EngineSpeed : VehiclePropertyType **/ class EngineSpeedProperty: public DBusSink { public: @@ -59,7 +59,7 @@ public: }; -/** @interface VehiclePowerMode **/ +/** @interface VehiclePowerMode : VehiclePropertyType **/ class VehiclePowerModeProperty: public DBusSink { public: @@ -75,7 +75,7 @@ public: } }; -/** @interface TripMeter **/ +/** @interface TripMeter : VehiclePropertyType **/ class TripMeterProperty: public DBusSink { public: @@ -103,7 +103,7 @@ public: } }; -/** @interface Acceleration **/ +/** @interface Acceleration : VehiclePropertyType **/ class AccelerationProperty: public DBusSink { public: @@ -131,7 +131,7 @@ public: } }; -/** @interface Transmission **/ +/** @interface Transmission : VehiclePropertyType **/ class TransmissionProperty: public DBusSink { public: @@ -163,7 +163,7 @@ public: } }; -/** @interface CruiseControlStatus **/ +/** @interface CruiseControlStatus : VehiclePropertyType **/ class CruiseControlProperty: public DBusSink { public: @@ -185,7 +185,7 @@ public: } }; -/** @interface WheelBrake **/ +/** @interface WheelBrake : VehiclePropertyType **/ class WheelBrakeProperty: public DBusSink { public: @@ -201,7 +201,7 @@ public: } }; -/** @interface LightStatus **/ +/** @interface LightStatus : VehiclePropertyType **/ class LightStatusProperty: public DBusSink { public: @@ -259,7 +259,7 @@ public: } }; -/** @interface InteriorLightStatus **/ +/** @interface InteriorLightStatus : VehiclePropertyType **/ class InteriorLightStatusProperty: public DBusSink { public: @@ -287,7 +287,7 @@ public: } }; -/** @interface Horn **/ +/** @interface Horn : VehiclePropertyType **/ class HornProperty: public DBusSink { public: @@ -303,7 +303,7 @@ public: } }; -/** @interface Fuel **/ +/** @interface Fuel : VehiclePropertyType **/ class FuelProperty: public DBusSink { public: @@ -343,7 +343,7 @@ public: } }; -/** @interface EngineOil **/ +/** @interface EngineOil : VehiclePropertyType **/ class EngineOilProperty: public DBusSink { public: @@ -371,7 +371,7 @@ public: } }; -/** @interface Location **/ +/** @interface Location : VehiclePropertyType **/ class LocationProperty: public DBusSink { public: diff --git a/plugins/dbus/vehicleinfo.h b/plugins/dbus/vehicleinfo.h index f597da42..eee6e3d1 100644 --- a/plugins/dbus/vehicleinfo.h +++ b/plugins/dbus/vehicleinfo.h @@ -6,7 +6,7 @@ #include "abstractdbusinterface.h" #include "abstractroutingengine.h" -/** @interface VehicleId **/ +/** @interface VehicleId : VehiclePropertyType **/ class VehicleId: public DBusSink { public: @@ -16,12 +16,15 @@ public: /** @attributeName WMI * @type DOMString * @access readonly + * @attributeComment \brief MUST return World Manufacturer Identifier (WMI) + * @attributeComment WMI is defined by SAE ISO 3780:2009. 3 characters. **/ wantPropertyString(VehicleProperty::WMI, "WMI", "s", AbstractProperty::Read); /** @attributeName VIN * @type DOMString * @access readonly + * @attributeComment \brief MUST return Vehicle Identification Number (VIN) as defined by ISO 3779. 17 characters. **/ wantPropertyString(VehicleProperty::VIN, "VIN", "s", AbstractProperty::Read); @@ -29,7 +32,7 @@ public: } }; -/** @interface Size **/ +/** @interface Size : VehiclePropertyType **/ class SizeProperty: public DBusSink { public: @@ -39,18 +42,21 @@ public: /** @attributeName Width * @type unsigned long * @access readonly + * @attributeComment \brief MUST return width of vehicle in mm **/ wantProperty<uint>(VehicleProperty::VehicleWidth, "Width", "u", AbstractProperty::Read); /** @attributeName Height * @type unsigned long * @access readonly + * @attributeComment \brief MUST return height of vehicle in mm **/ wantProperty<uint>(VehicleProperty::VehicleHeight, "Height", "u", AbstractProperty::Read); /** @attributeName Length * @type unsigned long * @access readonly + * @attributeComment \brief MUST return length of vehicle in mm **/ wantProperty<uint>(VehicleProperty::VehicleLength, "Length", "u", AbstractProperty::Read); @@ -58,22 +64,39 @@ public: } }; -/** @interface FuelInfo **/ +/** @interface FuelInfo : VehiclePropertyType **/ class FuelInfoProperty: public DBusSink { public: FuelInfoProperty(AbstractRoutingEngine* re, GDBusConnection* connection) :DBusSink("org.automotive.FuelInfo","/org/automotive/vehicleinfo/FuelInfo", re, connection, map<string, string>()) { + /** + * @enum const unsigned short FUELTYPE_GASOLINE = 0; + * @enum const unsigned short FUELTYPE_HIGH_OCTANE= 1; + * @enum const unsigned short FUELTYPE_DIESEL = 2; + * @enum const unsigned short FUELTYPE_ELECTRIC = 3; + * @enum const unsigned short FUELTYPE_HYDROGEN = 4; + **/ + /** @attributeName Type * @type unsigned short * @access readonly + * @attributeComment \brief MUST return type of fuel. integer 0-4 (see FUELTYPE_*) **/ wantProperty<Fuel::Type>(VehicleProperty::FuelType, "Type", "y", AbstractProperty::Read); + /** + * @enum const unsigned short REFUELPOSITION_LEFT = 0; + * @enum const unsigned short REFUELPOSITION_RIGHT= 1; + * @enum const unsigned short REFUELPOSITION_FRONT = 2; + * @enum const unsigned short REFUELPOSITION_REAR = 3; + **/ + /** @attributeName RefuelPosition * @type unsigned short * @access readonly + * @attributeComment \brief MUST return position of refuling (see REFUELPOSITION_*) **/ wantProperty<Fuel::RefuelPosition>(VehicleProperty::FuelPositionSide, "RefuelPosition", "y", AbstractProperty::Read); @@ -81,16 +104,26 @@ public: } }; -/** @interface VehicleType **/ +/** @interface VehicleType : VehiclePropertyType **/ class VehicleTypeProperty: public DBusSink { public: VehicleTypeProperty(AbstractRoutingEngine* re, GDBusConnection* connection) :DBusSink("org.automotive.VehicleType","/org/automotive/vehicleinfo/VehicleType", re, connection, map<string, string>()) { + /** + * @enum const unsigned short VEHICLETYPE_SEDAN = 0; + * @enum const unsigned short VEHICLETYPE_COUPE= 1; + * @enum const unsigned short VEHICLETYPE_CABRIOLE = 2; + * @enum const unsigned short VEHICLETYPE_ROADSTER = 3; + * @enum const unsigned short VEHICLETYPE_SUV = 4; + * @enum const unsigned short VEHICLETYPE_TRUCK = 5; + **/ + /** @attributeName Type * @type unsigned short * @access readonly + * @attributeComment \brief MUST return type of Vehicle. Integer 0-5 (see VEHICLETYPE_*) **/ wantProperty<Vehicle::Type>(VehicleProperty::VehicleType, "Type", "y", AbstractProperty::Read); @@ -98,7 +131,7 @@ public: } }; -/** @interface Doors **/ +/** @interface Doors : VehiclePropertyType **/ class DoorsProperty: public DBusSink { public: @@ -108,6 +141,10 @@ public: /** @attributeName DoorsPerRow * @type sequence<unsigned short> * @access readonly + * @attributeComment \brief MUST return Number of doors in each row. The index represents the row. Position '0' + * @attributeComment represents the first row, '1' the second row etc. + * @attributeComment Example a common mini-van may have Doors[0] = 2 doors, + * @attributeComment Doors[1] = 1 (side door), Doors[2] = 1 (trunk). **/ wantPropertyVariant(VehicleProperty::DoorsPerRow, "DoorsPerRow", "ay", AbstractProperty::Read); @@ -115,16 +152,23 @@ public: } }; -/** @interface TransmissionGearType **/ +/** @interface TransmissionGearType : VehiclePropertyType **/ class TransmissionInfoProperty: public DBusSink { public: TransmissionInfoProperty(AbstractRoutingEngine* re, GDBusConnection* connection) :DBusSink("org.automotive.TransmissionGearType","/org/automotive/vehicleinfo/TransmissionGearType", re, connection, map<string, string>()) { + /** + * @enum const unsigned short TRANSMISSIONGEARTYPE_AUTO=0; + * @enum const unsigned short TRANSMISSIONGEARTYPE_MANUAL=1; + * @enum const unsigned short TRANSMISSIONGEARTYPE_CV=2; + **/ + /** @attributeName TransmissionGearType * @type unsigned short * @access readonly + * @attributeComment \brief MUST return transmission gear type of either Automatic, Manual or Constant Variable (CV). See TRANSMISSIONGEARTYPE_*. **/ wantProperty<Transmission::Type>(VehicleProperty::TransmissionGearType, "TransmissionGearType", "y", AbstractProperty::Read); @@ -132,7 +176,7 @@ public: } }; -/** @interface WheelInformation **/ +/** @interface WheelInformation : VehiclePropertyType **/ class WheelInformationProperty: public DBusSink { public: @@ -143,18 +187,21 @@ public: /** @attributeName FrontWheelRadius * @type unsigned short * @access readonly + * @attributeComment \brief MUST return Radius of Front Wheel(s) in mm. **/ wantProperty<uint16_t>(VehicleProperty::FrontWheelRadius, "FrontWheelRadius", "q", AbstractProperty::Read); /** @attributeName RearWheelRadius * @type unsigned short * @access readonly + * @attributeComment \brief MUST return Radius of Rear Wheel(s) in mm. **/ wantProperty<uint16_t>(VehicleProperty::RearWheelRadius, "RearWheelRadius", "q", AbstractProperty::Read); /** @attributeName WheelTrack * @type unsigned long * @access readonly + * @attributeComment \brief MUST return Wheel Track in mm. **/ wantProperty<uint>(VehicleProperty::WheelTrack, "WheelTrack", "u", AbstractProperty::Read); diff --git a/plugins/websocketsink/websocketsinkmanager.cpp b/plugins/websocketsink/websocketsinkmanager.cpp index b21649ca..8b13dd53 100644 --- a/plugins/websocketsink/websocketsinkmanager.cpp +++ b/plugins/websocketsink/websocketsinkmanager.cpp @@ -781,7 +781,7 @@ static int websocket_callback(struct libwebsocket_context *context,struct libweb bool gioPollingFunc(GIOChannel *source,GIOCondition condition,gpointer data) { - DebugOut(5) << "Polling..." << condition << endl; + DebugOut(5) << "Polling..." << condition << endl; if (condition != G_IO_IN) { //Don't need to do anything |