Commit 046d2804 authored by Peter Waher's avatar Peter Waher

Sensor data documentation.

parent 502bed39
This diff is collapsed.
......@@ -9,4 +9,32 @@ Field <|-- Enumeration
Field <|-- Int32
Field <|-- Int64
Field <|-- Time
Field : Name
Field : Field Type
Field : Quality of Service
Field : Localization
Field : Custom Annotation
PhysicalQuantity : Value : xs:double
PhysicalQuantity : Unit : xs:string
String : Value : xs:string
Boolean : Value : xs:boolean
Date : Value : xs:date
DateTime : Value : xs:dateTime
Duration : Value : xs:duration
Enumeration : Value : xs:string
Enumeration : Type : xs:string
Int32 : Value : xs:int
Int64 : Value : xs:long
Time : Value : xs:time
@enduml
\ No newline at end of file
IEEE XMPP IoT Interfaces Working Group
========================================
This repository contains IEEE XMPP interfaces for the Internet of Things. These interfaces are worked on by the [IEEE XMPPI - XMPP Interface Working Group](https://standards.ieee.org/develop/wg/XMPPI.html), outside of the scope of the [XMPP Standards Foundation (XSF)](https://xmpp.org/about/xmpp-standards-foundation.html).
This repository contains IEEE XMPP interfaces for the Internet of Things. These interfaces are worked on by the
[IEEE XMPPI - XMPP Interface Working Group](https://standards.ieee.org/develop/wg/XMPPI.html), outside of the scope of the
[XMPP Standards Foundation (XSF)](https://xmpp.org/about/xmpp-standards-foundation.html).
Representation
-----------------
......
Request/Response communication pattern
=============================================
Legacy
-------------
The following data model is based on work done in the [XMPP Standards Foundation (XSF)](https://xmpp.org/about/xmpp-standards-foundation.html),
[XEP-0323: Internet of Things - Sensor Data](https://xmpp.org/extensions/xep-0323.html).
Apart from the differences noted in the [Sensor Data document](SensorData.md#legacy), here follows a list of noteable differences:
* A separation of XML representation and communication pattern has been done.
* Easier to respond for small/quick devices
* More data is signalled using a `more` attribute, instead of a lack of a `done` attribute.
This diff is collapsed.
......@@ -68,9 +68,9 @@
</xs:complexType>
</xs:element>
<xs:attributeGroup name='types'>
<xs:attributeGroup name='category'>
<xs:annotation>
<xs:documentation>Combinable attributes defining the type of a field or a set of fields.</xs:documentation>
<xs:documentation>Combinable attributes defining the category of a field or a set of fields.</xs:documentation>
</xs:annotation>
<xs:attribute name='m' type='xs:boolean' use='optional' default='false'>
<xs:annotation>
......@@ -114,6 +114,14 @@
<xs:documentation>The optional x element can be used to extend the annotation of the field using custom features.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice>
<xs:any namespace='##any' minOccurs='0' maxOccurs='unbounded'>
<xs:annotation>
<xs:documentation>Any child elements can be added to the x element.</xs:documentation>
<xs:documentation>Only fully qualified elements (i.e. using a namespace) that have been approved by a standards group can be used for interoperable features.</xs:documentation>
</xs:annotation>
</xs:any>
</xs:choice>
<xs:anyAttribute namespace='##any'>
<xs:annotation>
<xs:documentation>Annotation of fields can be done using any attribute on the x element.</xs:documentation>
......@@ -128,9 +136,9 @@
<xs:documentation>Name of the field.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref='types'>
<xs:attributeGroup ref='category'>
<xs:annotation>
<xs:documentation>Type of field, defined as a set of attributes.</xs:documentation>
<xs:documentation>Field category, defined as a set of attributes.</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
<xs:attributeGroup ref='qos'>
......@@ -470,14 +478,14 @@
<xs:documentation>Identity of request. Is used to match response messages to the original request.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref='types'>
<xs:attributeGroup ref='category'>
<xs:annotation>
<xs:documentation>Types of fields requested.</xs:documentation>
<xs:documentation>Categories of fields requested.</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
<xs:attribute name='all' type='xs:boolean' use='optional' default='false'>
<xs:annotation>
<xs:documentation>Field used to request all types of fields.</xs:documentation>
<xs:documentation>Field used to request all categories of fields.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name='from' type='xs:dateTime' use='optional'>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment