comparison docs/keylist.rst @ 65:256b3f3e35e9

Add M209 class docs.
author Brian Neal <bgneal@gmail.com>
date Sat, 20 Jul 2013 18:52:45 -0500
parents 72e0bda6df40
children 2173ac4c2d9b
comparison
equal deleted inserted replaced
64:72e0bda6df40 65:256b3f3e35e9
13 * ``pin_list`` - a list of six strings which represent key wheel pin 13 * ``pin_list`` - a list of six strings which represent key wheel pin
14 settings; see below 14 settings; see below
15 * ``letter_check`` - a string representing the letter check used to verify 15 * ``letter_check`` - a string representing the letter check used to verify
16 operator settings; if unknown this can be ``None`` or an empty string 16 operator settings; if unknown this can be ``None`` or an empty string
17 17
18 .. _lug-settings:
19
18 Lug settings format 20 Lug settings format
19 ~~~~~~~~~~~~~~~~~~~ 21 ~~~~~~~~~~~~~~~~~~~
20 22
21 Drum lug settings are often conveniently represented as strings consisting of 23 Drum lug settings are often conveniently represented as strings consisting of
22 at most 27 whitespace-separated pairs of integers separated by dashes. For 24 at most 27 whitespace-separated pairs of integers separated by dashes. For
43 are ``k`` copies of the preceeding lug pair combination. For example, these two 45 are ``k`` copies of the preceeding lug pair combination. For example, these two
44 strings describe identical drum configurations:: 46 strings describe identical drum configurations::
45 47
46 lugs1 = '2-4 2-4 2-4 0-1 0-1' 48 lugs1 = '2-4 2-4 2-4 0-1 0-1'
47 lugs2 = '2-4*3 0-1*2' 49 lugs2 = '2-4*3 0-1*2'
50
51 .. _pin-settings:
48 52
49 Key wheel pin settings 53 Key wheel pin settings
50 ~~~~~~~~~~~~~~~~~~~~~~ 54 ~~~~~~~~~~~~~~~~~~~~~~
51 55
52 Key wheel pin settings are represented as iterables of letters whose pins are 56 Key wheel pin settings are represented as iterables of letters whose pins are