Added unit / type in attributes desc

git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@2460 b32b6428-25c9-4566-ad07-03861ab6144f

libs/schemas/xaal/schemas/dev.mako

@@ -7,7 +7,18 @@ def ${name}(addr=None):
     
     # -- Attributes --
     % for attr in attributes:  
-    <% dm = datamodel[attributes[attr]] %># ${dm['description']}
+<% 
+    dm = datamodel[attributes[attr]] 
+    desc = dm.get('description','no-desc ?')
+    type_ = dm.get('type')
+    unit = dm.get('unit')
+    comment = desc
+    if type_:
+        comment = comment +' | type: ' + type_
+    if unit:
+        comment = comment +' | unit: ' + unit
+
+%>    # ${comment}
     dev.new_attribute('${attr}')
     % endfor
     % endif

libs/schemas/xaal/schemas/devices.py

@@ -18,7 +18,7 @@ def barometer(addr=None):
     dev = Device('barometer.basic',addr)
     
     # -- Attributes --
-    # Atmospheric pressure
+    # Atmospheric pressure | type: data = number | unit: mbar
     dev.new_attribute('pressure')
     return dev
 
@@ -36,9 +36,9 @@ def battery(addr=None):
     dev = Device('battery.basic',addr)
     
     # -- Attributes --
-    # Battery energy level
+    # Battery energy level | type: data = (0..100) / (0.0..100.0) | unit: %EL
     dev.new_attribute('level')
-    # List of devices concerned with this battery
+    # List of devices concerned with this battery | type: data = [ * #6.37(bstr .size 16) ]
     dev.new_attribute('devices')
     return dev
 
@@ -86,7 +86,7 @@ def co2meter(addr=None):
     dev = Device('co2meter.basic',addr)
     
     # -- Attributes --
-    # CO2
+    # CO2 | type: data = uint | unit: ppm
     dev.new_attribute('co2')
     return dev
 
@@ -97,7 +97,7 @@ def contact(addr=None):
     dev = Device('contact.basic',addr)
     
     # -- Attributes --
-    # Detection status of the contact sensor
+    # Detection status of the contact sensor | type: data = bool
     dev.new_attribute('detected')
     return dev
 
@@ -108,7 +108,7 @@ def door(addr=None):
     dev = Device('door.basic',addr)
     
     # -- Attributes --
-    # Position of the door (true=open false=close)
+    # Position of the door (true=open false=close) | type: data = bool
     dev.new_attribute('position')
 
     # -- Methods --
@@ -132,7 +132,7 @@ def falldetector(addr=None):
     dev = Device('falldetector.basic',addr)
     
     # -- Attributes --
-    # List of detected falls - List of objects {delay,zone,x,y} whose semantic is device-dependent; Each object means a fall; An empty object means a detecting fall with no additional info; An empty list means no detected fall.
+    # List of detected falls - List of objects {delay,zone,x,y} whose semantic is device-dependent; Each object means a fall; An empty object means a detecting fall with no additional info; An empty list means no detected fall. | type: data = [ * { ?"delay":#6.1(uint), ?"zone":tstr, ?"x":number, ?"y":number } ]
     dev.new_attribute('falls')
     return dev
 
@@ -143,7 +143,7 @@ def gateway(addr=None):
     dev = Device('gateway.basic',addr)
     
     # -- Attributes --
-    # List of embeded devices
+    # List of embeded devices | type: data = [ * #6.37(bstr .size 16) ]
     dev.new_attribute('embedded')
     return dev
 
@@ -161,7 +161,7 @@ def hygrometer(addr=None):
     dev = Device('hygrometer.basic',addr)
     
     # -- Attributes --
-    # Humidity
+    # Humidity | type: data = (0..100) / (0.0..100.0) | unit: %RH
     dev.new_attribute('humidity')
     return dev
 
@@ -172,7 +172,7 @@ def lamp(addr=None):
     dev = Device('lamp.basic',addr)
     
     # -- Attributes --
-    # State of the lamp (true=on false=off)
+    # State of the lamp (true=on false=off) | type: data = bool
     dev.new_attribute('light')
 
     # -- Methods --
@@ -196,17 +196,17 @@ def lamp_color(addr=None):
     dev = Device('lamp.color',addr)
     
     # -- Attributes --
-    # State of the lamp (true=on false=off)
+    # State of the lamp (true=on false=off) | type: data = bool
     dev.new_attribute('light')
-    # Level of the brightness
+    # Level of the brightness | type: data = (0..100) / (0.0..100.0) | unit: %
     dev.new_attribute('brightness')
-    # Color themperature of the white
+    # Color themperature of the white | type: data = 1000..10000 | unit: K
     dev.new_attribute('color_themperature')
-    # Color description in hue-saturation-value coding
+    # Color description in hue-saturation-value coding | type: data = [ ((0..360)/(0.0..360.0)),  (0.0..1.0),  (0.0..1.0) ]
     dev.new_attribute('hsv')
-    # Mode of the lamp
+    # Mode of the lamp | type: data = "white" / "color" / "scene"
     dev.new_attribute('mode')
-    # Scene name
+    # Scene name | type: data = tstr
     dev.new_attribute('scene')
 
     # -- Methods --
@@ -255,11 +255,11 @@ def lamp_dimmer(addr=None):
     dev = Device('lamp.dimmer',addr)
     
     # -- Attributes --
-    # State of the lamp (true=on false=off)
+    # State of the lamp (true=on false=off) | type: data = bool
     dev.new_attribute('light')
-    # Level of the brightness
+    # Level of the brightness | type: data = (0..100) / (0.0..100.0) | unit: %
     dev.new_attribute('brightness')
-    # Color themperature of the white
+    # Color themperature of the white | type: data = 1000..10000 | unit: K
     dev.new_attribute('color_themperature')
 
     # -- Methods --
@@ -293,7 +293,7 @@ def lamp_toggle(addr=None):
     dev = Device('lamp.toggle',addr)
     
     # -- Attributes --
-    # State of the lamp (true=on false=off)
+    # State of the lamp (true=on false=off) | type: data = bool
     dev.new_attribute('light')
 
     # -- Methods --
@@ -322,7 +322,7 @@ def lightgauge(addr=None):
     dev = Device('lightgauge.basic',addr)
     
     # -- Attributes --
-    # Brightness indicator without units (scaled in 100 levels of brightness; Information is transmitted in percentage). Simple LDR (photoresistor).
+    # Brightness indicator without units (scaled in 100 levels of brightness; Information is transmitted in percentage). Simple LDR (photoresistor). | type: data = (0..100) / (0.0..100.0) | unit: %
     dev.new_attribute('brightness')
     return dev
 
@@ -333,9 +333,9 @@ def linkquality(addr=None):
     dev = Device('linkquality.basic',addr)
     
     # -- Attributes --
-    # Link quality
+    # Link quality | type: data = (0..100) / (0.0..100.0) | unit: %
     dev.new_attribute('level')
-    # List of devices concerned with this link
+    # List of devices concerned with this link | type: data = [ * #6.37(bstr .size 16) ]
     dev.new_attribute('devices')
     return dev
 
@@ -346,7 +346,7 @@ def luxmeter(addr=None):
     dev = Device('luxmeter.basic',addr)
     
     # -- Attributes --
-    # Lux
+    # Lux | type: data = number | unit: lx
     dev.new_attribute('illuminance')
     return dev
 
@@ -387,7 +387,7 @@ def motion(addr=None):
     dev = Device('motion.basic',addr)
     
     # -- Attributes --
-    # State of the presence (true=yes false=no)
+    # State of the presence (true=yes false=no) | type: data = bool
     dev.new_attribute('presence')
     return dev
 
@@ -398,11 +398,11 @@ def powermeter(addr=None):
     dev = Device('powermeter.basic',addr)
     
     # -- Attributes --
-    # Current power
+    # Current power | type: data = number | unit: W
     dev.new_attribute('power')
-    # Energy used or produced since cycle beginning
+    # Energy used or produced since cycle beginning | type: data = number | unit: kWh
     dev.new_attribute('energy')
-    # List of devices concerned with this powermeter
+    # List of devices concerned with this powermeter | type: data = [ * #6.37(bstr .size 16) ]
     dev.new_attribute('devices')
     return dev
 
@@ -413,7 +413,7 @@ def powerrelay(addr=None):
     dev = Device('powerrelay.basic',addr)
     
     # -- Attributes --
-    # State of the relay (true=on false=off)
+    # State of the relay (true=on false=off) | type: data = bool
     dev.new_attribute('power')
 
     # -- Methods --
@@ -437,7 +437,7 @@ def powerrelay_toggle(addr=None):
     dev = Device('powerrelay.toggle',addr)
     
     # -- Attributes --
-    # State of the relay (true=on false=off)
+    # State of the relay (true=on false=off) | type: data = bool
     dev.new_attribute('power')
 
     # -- Methods --
@@ -466,9 +466,9 @@ def raingauge(addr=None):
     dev = Device('raingauge.basic',addr)
     
     # -- Attributes --
-    # Real-time amount of rainfall
+    # Real-time amount of rainfall | type: data = number | unit: mm
     dev.new_attribute('rain')
-    # Accumulated precipitation
+    # Accumulated precipitation | type: data = number | unit: mm
     dev.new_attribute('accumulated')
     return dev
 
@@ -479,7 +479,7 @@ def scale(addr=None):
     dev = Device('scale.basic',addr)
     
     # -- Attributes --
-    # Weight
+    # Weight | type: data = number | unit: gram
     dev.new_attribute('weight')
     return dev
 
@@ -490,9 +490,9 @@ def scenario(addr=None):
     dev = Device('scenario.basic',addr)
     
     # -- Attributes --
-    # State of scenario (true=enabled false=disabled)
+    # State of scenario (true=enabled false=disabled) | type: data = bool
     dev.new_attribute('enabled')
-    # Fancy properties defined and managed by the scenario, if any
+    # Fancy properties defined and managed by the scenario, if any | type: data = { * (tstr => tstr) }
     dev.new_attribute('properties')
 
     # -- Methods --
@@ -526,7 +526,7 @@ def shutter(addr=None):
     dev = Device('shutter.basic',addr)
     
     # -- Attributes --
-    # Ongoing action of the shutter
+    # Ongoing action of the shutter | type: data = "up" / "down" / "stop"
     dev.new_attribute('action')
 
     # -- Methods --
@@ -555,9 +555,9 @@ def shutter_position(addr=None):
     dev = Device('shutter.position',addr)
     
     # -- Attributes --
-    # Ongoing action of the shutter
+    # Ongoing action of the shutter | type: data = "up" / "down" / "stop"
     dev.new_attribute('action')
-    # Level of aperture of the shutter
+    # Level of aperture of the shutter | type: data = (0..100) / (0.0..100.0) | unit: %
     dev.new_attribute('position')
 
     # -- Methods --
@@ -591,7 +591,7 @@ def soundmeter(addr=None):
     dev = Device('soundmeter.basic',addr)
     
     # -- Attributes --
-    # Sound intensity
+    # Sound intensity | type: data = number | unit: dB
     dev.new_attribute('sound')
     return dev
 
@@ -602,7 +602,7 @@ def switch(addr=None):
     dev = Device('switch.basic',addr)
     
     # -- Attributes --
-    # Position of the switch (true=on false=off)
+    # Position of the switch (true=on false=off) | type: data = bool
     dev.new_attribute('position')
     return dev
 
@@ -613,7 +613,7 @@ def thermometer(addr=None):
     dev = Device('thermometer.basic',addr)
     
     # -- Attributes --
-    # Temperature
+    # Temperature | type: data = number | unit: Cel
     dev.new_attribute('temperature')
     return dev
 
@@ -639,13 +639,13 @@ def windgauge(addr=None):
     dev = Device('windgauge.basic',addr)
     
     # -- Attributes --
-    # Strength of the wind
+    # Strength of the wind | type: data = number | unit: m/s
     dev.new_attribute('wind_strength')
-    # Direction of the wind
+    # Direction of the wind | type: data = (0..360) / (0.0..360.0) | unit: °
     dev.new_attribute('wind_angle')
-    # Strength of gusts
+    # Strength of gusts | type: data = number | unit: m/s
     dev.new_attribute('gust_strength')
-    # Direction of gusts
+    # Direction of gusts | type: data = (0..360) / (0.0..360.0) | unit: °
     dev.new_attribute('gust_angle')
     return dev
 
@@ -656,7 +656,7 @@ def window(addr=None):
     dev = Device('window.basic',addr)
     
     # -- Attributes --
-    # Position of the window (true=open false=close)
+    # Position of the window (true=open false=close) | type: data = bool
     dev.new_attribute('position')
 
     # -- Methods --
@@ -680,7 +680,7 @@ def worktop(addr=None):
     dev = Device('worktop.basic',addr)
     
     # -- Attributes --
-    # Ongoing action of the worktop
+    # Ongoing action of the worktop | type: data = "up" / "down" / "stop"
     dev.new_attribute('action')
 
     # -- Methods --