Mercurial > public > m209
comparison docs/m209.rst @ 69:2173ac4c2d9b
Adjust TOC depth. Add link to StdProcedure from M209 description.
author | Brian Neal <bgneal@gmail.com> |
---|---|
date | Sun, 21 Jul 2013 14:07:20 -0500 |
parents | a2647b9fe107 |
children |
comparison
equal
deleted
inserted
replaced
68:30aa114bb746 | 69:2173ac4c2d9b |
---|---|
2 ========== | 2 ========== |
3 | 3 |
4 Naturally, the ``m209`` library includes a class that simulates a M-209 | 4 Naturally, the ``m209`` library includes a class that simulates a M-209 |
5 converter. The :class:`~m209.converter.M209` class allows you to experiment | 5 converter. The :class:`~m209.converter.M209` class allows you to experiment |
6 with all moving parts of an M-209, including encrypting and decrypting | 6 with all moving parts of an M-209, including encrypting and decrypting |
7 messages. Keep in mind there is a higher level class, StdProcedure, that | 7 messages. Keep in mind there is a higher level class, |
8 encapsulates all the steps of the standard encrypting and decrypting | 8 :class:`~m209.procedure.StdProcedure`, that encapsulates all the steps of the |
9 operations, including generating indicators and placing or removing them from | 9 standard encrypting and decrypting operations, including generating indicators |
10 messages. However if you need lower-level access or you are inventing your own | 10 and placing or removing them from messages. However if you need lower-level |
11 procedures, you would use the M209 class directly. | 11 access or you are inventing your own procedures, you would use the M209 class |
12 directly. | |
12 | 13 |
13 .. class:: m209.converter.M209([lugs=None[, pin_list=None]]) | 14 .. class:: m209.converter.M209([lugs=None[, pin_list=None]]) |
14 | 15 |
15 The ``M209`` class takes the following optional arguments. | 16 The ``M209`` class takes the following optional arguments. |
16 | 17 |