diff --git a/SDT/schema3.0/docs/Introduction.md b/SDT/schema3.0/docs/Introduction.md index 5b539f91858408dc0b21d075998087a1fffa577f..5069a946994401fbb209cadd82cc5394cd058a65 100644 --- a/SDT/schema3.0/docs/Introduction.md +++ b/SDT/schema3.0/docs/Introduction.md @@ -81,3 +81,9 @@ NOT directly part of this work is a related but separate aspect of every gateway Programmers developing a "device abstraction layer" for software in a gateway need to create run-time representations of all the recognized devices, their operations and their actual states. This internal "information model" needs to be updated in real time as the devices and the users interact. Programmers may be tempted to use the SDT structure to organize their real-time information model, adding additional information elements for the current state of each device, for some kind of "history" of commands sent/acknowledged, the user etc. The above is an efficient approach BUT it must be clear that the real-time state information and history of events, etc, can NOT be represented in a pre-defined SDT and in the XML giving specific details for a device. + +--- + +Click [here](SDT_Components.md) for detailed documentation about SDT. + + diff --git a/SDT/schema3.0/docs/SDT_Components.md b/SDT/schema3.0/docs/SDT_Components.md index 533da50de043a6b91d5898706abfc1b37ebf7e51..6360f99bcdab073571bdd7c3537532979b07bb12 100644 --- a/SDT/schema3.0/docs/SDT_Components.md +++ b/SDT/schema3.0/docs/SDT_Components.md @@ -5,6 +5,7 @@ [Property](#Property) [Module and ModuleClass](#ModuleClass) [Action](#Action) + [Arg](#Arg) [DataPoint](#DataPoint) [Event](#Event) [Data Types](#Data_Types) @@ -304,26 +305,6 @@ The following are two examples for actions implementing a getter and a setter fo </Args> </Action> ---- -<a name="Arg"/></a> -### Arg : Element of *Action* - - - -The *Arg* element represents the parameter information which a device needs to carry out a required *Action*. - -The *Arg* has the following attributes and elements: - -#### Attributes -- **name** : The name of the *Arg* attribute. Required. - -#### Elements -- **[Doc](#Documentation)** : Documentation for the *argument*. Optional. -- **[DataType](#DataType)** : The return type of the *argument*. It must comply to the *DataType* definition. Required. - -#### Example -See [example above](#ActionExample). - --- <a name="Event"/></a> @@ -356,6 +337,27 @@ See [example above](#ActionExample). --- +<a name="Arg"/></a> +### Arg : Element of *Action* + + + +The *Arg* element represents the parameter information which a device needs to carry out a required *Action*. + +The *Arg* has the following attributes and elements: + +#### Attributes +- **name** : The name of the *Arg* attribute. Required. + +#### Elements +- **[Doc](#Documentation)** : Documentation for the *argument*. Optional. +- **[DataType](#DataType)** : The return type of the *argument*. It must comply to the *DataType* definition. Required. + +#### Example +See [example above](#ActionExample). + +--- + <a name="Data_Types"/></a> ### DataType The data type can be simple integers or string text, or rather complex, as shown below: @@ -383,7 +385,7 @@ The *DataType* element is a "container" for the various aspects of a type. --- <a name="Constraint"/></a> -### Constraint +### Constraint : Element of DataType  diff --git a/SDT/schema3.0/docs/images/MC.Action.DataPoint.Event.png b/SDT/schema3.0/docs/images/MC.Action.DataPoint.Event.png index db3c9f52e1f4d0ad4ab3177f9c25f0cd9aaf9480..057d2b288cfa5293c782f0106e52b288daf7e59f 100644 Binary files a/SDT/schema3.0/docs/images/MC.Action.DataPoint.Event.png and b/SDT/schema3.0/docs/images/MC.Action.DataPoint.Event.png differ