Changeset 42 in pacpussensors for trunk/Sick/SickComponent.h

Timestamp:

04/01/14 14:47:39 (10 years ago)

Author:

cfougera

Message:

Last version

File:

• trunk/Sick/SickComponent.h (modified) (1 diff)

trunk/Sick/SickComponent.h

@@ -70 +70 @@
      * @param config XML file passed in order to configure the Sick Component.
      *
-     * This function instanciate every sensor configured through the XML file.
-     * The XML file must be formated as expected by this function, see [annexe TODO]{TODO}.
+     * This function instanciate every sensors configured through the XML file.
+     * The XML file must be formated as expected by this function.
+     * Depending on used sensors and how many, you should define these three property in a "Sick" node (X must start from '0') :
+     * - sickldmrs_X
+     * - sicklms151_X
+     * - sicklms511_X
+     *
+     * For example, let's say we have two Sick LMS151, one LDMRS and one LMS511 :
+     *
+     * <tt> <Sick type="SickComponent" sickldmrs_0="192.168.0.1:2111" sicklms151_0="192.168.0.10:2111" sicklms151_1="192.168.0.11:2111" sicklms511_0="192.168.1.50:2111" /> </tt>
+     *
+     * Do not forget \c type="SickComponent".
      */
     virtual ComponentBase::COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config);