Changes between Version 91 and Version 92 of UserGuideGit

Timestamp:

Nov 23, 2017, 9:30:21 AM (8 years ago)

Author:

fma

Comment:

--

UserGuideGit

@@ -185 +185 @@
 * {{{_buildComponents(self)}}}
 
-Here, we create the components of the remote control
-
-The following methods are used to setup the remote control:
+Here, we create the components of the remote control.
+
+A number of helper methods are used to setup the remote control:
 
  * {{{_addConfig(self, config)}}}
+  * '''config''': str ot list/tuple of str, containing the name of the config(s).
+
  * {{{_addComponent(self, cls, **kwargs)}}}
-
-(See below)
-
-Then, a number of objects/methods can be used as components commands:
+  * '''cls''' is the {{{Component}}} class to instantiate. For now, {{{Button}}}, {{{Switch}}}, {{{Analog}}} or {{{Joystick}}};
+  * '''configs''' (optional) contains the config(s) where this {{{Component}}} will be valid. Several configs can be given has list/tuple. By default, the {{{Component}}} will be valid in all configs;
+  * '''command''' is a Python callable (function, method...) which can be reached from our class. You may remember that we gave the robot instance when instantiating the gamepad object; this way, we can refer to all robot methods through {{{self.robot}}}. We can directly reach {{{GaitSequencer}}} as it is a singleton;
+  * '''key'''/'''keys'''  is the input {{{Frontend}}} key to associate with the {{{Component}}}. There are 2 types of keys: ''button_'' and ''analog_'';
+  * '''modifier''' (optional) is a key (must be a ''button_'' type) which must be pressed together with the main '''key''' to trigger the '''command''';
+  * '''mapper''' is a {{{Mapper}}}s, another Python callable which translates {{{RemoteControl}}} {{{Component}}} output to '''command''' input.
 
  * {{{selectPreviousConfig(self)}}}
+
  * {{{selectNextConfig(self)}}}
+
  * {{{robot}}}
 
-The {{{robot}}} object is used to reach the robot methods from the components.
+The {{{robot}}} object is used to reach the robot methods from the {{{component}}}s.
 
 === Component ===