Changes between Version 93 and Version 94 of UserGuideGit

Timestamp:

Nov 23, 2017, 3:31:41 PM (8 years ago)

Author:

fma

Comment:

--

UserGuideGit

@@ -175 +175 @@
 [[Image(design_remote-control.png, 300px)]]
 
-As you can see on the UML diagram, a {{{RemoteControl}}} object uses {{{Components}}}; a {{{Component}}} can be a {{{Button}}}, a {{{Switch}}} an {{{Analog}}}, or a {{{Joystick}}}.
+As you can see on the UML diagram, a {{{RemoteControl}}} object uses {{{Components}}}; a {{{Component}}} can be a {{{Button}}}, a {{{Switch}}} an {{{Axis}}}, or a {{{Joystick}}}.
 
 {{{RemoteControl}}} has the following virtual methods which must be override in a custom remote control class:
@@ -193 +193 @@
 
  * {{{_addComponent(self, cls, **kwargs)}}}
-  * '''cls''' is the {{{Component}}} class to instantiate. For now, {{{Button}}}, {{{Switch}}}, {{{Analog}}} or {{{Joystick}}};
+  * '''cls''' is the {{{Component}}} class to instantiate. For now, {{{Button}}}, {{{Switch}}}, {{{Axis}}} 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''';
-  * '''curve''' response {{{Curve}}} of the input - for {{{Analog}}}/{{{Joystick}}} only;
+  * '''threshold''' is the value {{{Axis}}}/{{{Joystick}}} have to change to trigger;
+  * '''curve''' response {{{Curve}}} of the input - for {{{Axis}}}/{{{Joystick}}} only;
   * '''mapper''' is a {{{Mapper}}}s, another Python callable which translates {{{RemoteControl}}} {{{Component}}} output to '''command''' input.
 
@@ -230 +231 @@
 {{{Switch}}} is a button toggling between 2 states when you press it.
 
-==== Analog ====
-
-{{{Analog}}} handles a single analog axis.
+==== Axis ====
+
+{{{Axis}}} handles a single analog axis.
 
 ==== Joystick ====
 
-{{{Joystick}}} combines several {{{Analog}}} axes.
+{{{Joystick}}} combines several analog axes.
 
 === Configurations and modifiers ===