Changes between Version 95 and Version 96 of UserGuideGit


Ignore:
Timestamp:
Nov 29, 2017, 7:45:42 PM (8 years ago)
Author:
fma
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UserGuideGit

    v95 v96  
    196196  * '''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;
    197197  * '''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;
    198   * '''key'''/'''keys'''  is the input {{{Frontend}}} key to associate with the {{{Component}}}. There are 2 types of keys: ''button_'' and ''analog_'';
    199   * '''modifier''' (optional) is a key (must be a ''button_'' type) which must be pressed together with the main '''key''' to trigger the '''command''';
     198  * '''key'''/'''keys'''  is the input {{{Frontend}}} key to associate with the {{{Component}}}. There are 2 types of keys: ''digital_'' and ''analog_'';
     199  * '''modifier''' (optional) is a key (must be a ''digital_'' type) which must be pressed together with the main '''key''' to trigger the '''command''';
    200200  * '''threshold''' is the minimum value {{{Axis}}}/{{{Joystick}}} must reach to trigger;
    201201  * '''curve''' response {{{Curve}}} of the input - for {{{Axis}}}/{{{Joystick}}} only;
     
    245245To create ''configurations'', use the {{{_addConfig()}}} method. This method take a string as argument, the name of the ''configuration''. It is then possible to restrict a {{{Component}}} to a specific ''configuration'' by giving its name in the '''configs''' param (it is possible to give a list/tuple for several ''configurations''). Without it, the {{{Component}}} is active in all ''configurations''.
    246246
    247 A ''modifier'' works as Shift, Ctrl or Alt keys on a keyboard, i.e. the {{{Component}}} will only react if the ''modifier'' is press. A ''modifier'' can only be a key starting with {{{button_}}}.
     247A ''modifier'' works as Shift, Ctrl or Alt keys on a keyboard, i.e. the {{{Component}}} will only react if the ''modifier'' is press. A ''modifier'' can only be a key starting with {{{digital_}}}.
    248248
    249249=== Mapper ===