Added comments to create Doxygen Modules for some of the DM BIBBs (DCC, Who-Is, RD) so far.

2010-02-23 02:43:16 +00:00
parent 8deecad15b
commit 60247fa55f
11 changed files with 157 additions and 7 deletions
@@ -97,4 +97,26 @@ extern "C" {
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
+
+/** @defgroup RDMS Remote Device Management Services BIBBs
+ * These device management BIBBs prescribe the BACnet capabilities required 
+ * to interoperably perform the device management functions enumerated in 
+ * 22.2.1.5 for the BACnet devices defined therein. 
+ */
+
+/** @defgroup DMDCC Device Management-Device Communication Control (DM-DCC)
+ * @ingroup RDMS
+ * 16.1 DeviceCommunicationControl Service <br>
+ * The DeviceCommunicationControl service is used by a client BACnet-user to 
+ * instruct a remote device to stop initiating and optionally stop responding 
+ * to all APDUs (except DeviceCommunicationControl or, if supported, 
+ * ReinitializeDevice) on the communication network or internetwork for a 
+ * specified duration of time. This service is primarily used by a human operator
+ * for diagnostic purposes. A password may be required from the client 
+ * BACnet-user prior to executing the service. The time duration may be set to 
+ * "indefinite," meaning communication must be re-enabled by a 
+ * DeviceCommunicationControl or, if supported, ReinitializeDevice service, 
+ * not by time.
+ */
+
 #endif
@@ -83,4 +83,20 @@ extern "C" {
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
+
+/** @defgroup DMRD Device Management-ReinitializeDevice (DM-RD)
+ * @ingroup RDMS
+ * 16.4 ReinitializeDevice Service <br>
+ * The ReinitializeDevice service is used by a client BACnet-user to instruct 
+ * a remote device to reboot itself (cold start), reset itself to some 
+ * predefined initial state (warm start), or to control the backup or restore 
+ * procedure. Resetting or rebooting a device is primarily initiated by a human 
+ * operator for diagnostic purposes. Use of this service during the backup or 
+ * restore procedure is usually initiated on behalf of the user by the device 
+ * controlling the backup or restore. Due to the sensitive nature of this 
+ * service, a password may be required from the responding BACnet-user prior 
+ * to executing the service.
+ * 
+ */
+
 #endif
@@ -67,4 +67,25 @@ extern "C" {
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
+
+/** @defgroup DMDDB Device Management-Dynamic Device Binding (DM-DDB)
+ * @ingroup RDMS
+ * 16.10 Who-Is and I-Am Services <br>
+ * The Who-Is service is used by a sending BACnet-user to determine the device 
+ * object identifier, the network address, or both, of other BACnet devices 
+ * that share the same internetwork. 
+ * The Who-Is service is an unconfirmed service. The Who-Is service may be used 
+ * to determine the device object identifier and network addresses of all devices 
+ * on the network, or to determine the network address of a specific device whose 
+ * device object identifier is known, but whose address is not. <br> 
+ * The I-Am service is also an unconfirmed service. The I-Am service is used to 
+ * respond to Who-Is service requests. However, the I-Am service request may be 
+ * issued at any time. It does not need to be preceded by the receipt of a 
+ * Who-Is service request. In particular, a device may wish to broadcast an I-Am 
+ * service request when it powers up. The network address is derived either
+ * from the MAC address associated with the I-Am service request, if the device 
+ * issuing the request is on the local network, or from the NPCI if the device 
+ * is on a remote network.
+ */
+
 #endif