ch10_13_handbook:start
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| ch10_13_handbook:start [2014/08/11 16:41] – [CR031 - XML Mapping to Chapter 10] pferrill | ch10_13_handbook:start [2014/09/12 15:40] (current) – [SAMPLE CODE] mcferrill | ||
|---|---|---|---|
| Line 13: | Line 13: | ||
| [[RECORDER COMMAND AND CONTROL]] | [[RECORDER COMMAND AND CONTROL]] | ||
| - | * Network Control | ||
| - | IRIG 106-09 added the ability to issue Chapter 6 commands via a TELNET interface. It does not specify how this interface is to be configured nor does it provide any specific commands for that purpose. | ||
| - | -------- | ||
| - | ==== CR031 - XML Mapping to Chapter 10 ==== | + | ==== SAMPLE CODE ==== |
| + | Many if not most programmers learn best from sample code. This update to the IRIG 106 Programmer' | ||
| - | It was decided during an Recorder Vendor Working Group telecon to push CR031 into an appendix of the next release of the programmer' | + | [[Python Code using DLL]] |
| - | <code XML> | + | === Samples Repository === |
| - | <?xml version=" | + | The samples repository is hosted on bitbucket [[https://bitbucket.org/pychapter10/handbook-samples|here]]. |
| - | < | + | Included in the repository are basic installation and usage directions akin to what is given here. |
| - | | + | |
| - | xsi: | + | |
| - | | + | |
| - | <!-- Include some predefined TMATS file --> | + | The samples are organized into 3 categories: |
| - | <cns:Packet ChannelID=" | + | * c - Standard C samples using the Irig 106 library (from irig106.org) |
| - | < | + | * pyi106 |
| - | < | + | * pyc10 - Pure Python samples using the PyChapter10 library. |
| - | </ | + | |
| - | </ | + | |
| - | <!-- Create | + | Each of the above directories has the same basic samples written as similarly as possible to perform the following tasks: |
| - | < | + | * stat - Read a .ch10/.c10 file and display information on the data it contains. Can also filter report based on data type and channel ID. |
| - | < | + | * copy - Copy packets |
| - | < | + | * dump - Export packet contents to separate files (eg. export video data to .mpg files). Can also filter based on data type and channel ID. |
| - | </ | + | * video - Full GUI application that will play split-screen video directly from a chapter 10 file as it is parsed in the background. |
| - | </ | + | * reindex (C sample still work in progress) |
| - | + | * listen (work in progress) | |
| - | <!-- Define further time packets | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | + | ||
| - | <!-- Further attributes could be defined but are optional--> | + | |
| - | < | + | |
| - | DataType=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | + | ||
| - | <!-- Errors can be introduced--> | + | |
| - | < | + | |
| - | PacketLength=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | <!-- Packets can have secondary headers--> | + | **Dependencies (C samples)** |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | <!-- Secondary headers can have errors too--> | + | * Visual studio (developed on VS Ultimate 2013) |
| - | < | + | * Qt 5 & Qt visual studio plugin (for video sample) |
| - | < | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | <!-- raw data like packet flags and CSDW can be defined as a base an modified by further options --> | + | **Dependencies (Python Samples)** |
| - | < | + | |
| - | DataOverflow=" | + | |
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | </ | + | |
| - | <!-- Arbitrary data can be added between packets--> | + | * Python 2.7 |
| - | < | + | * PyChapter10 (see above, for pyc10 samples only) |
| - | < | + | * [[http:// |
| + | * [[http:// | ||
| - | <!-- New packet types can be created--> | + | **Building and Running (C samples)** |
| - | < | + | |
| - | < | + | The code for the C samples are (as much as possible) kept in the src directory under C samples. The code has comments outlining the different sections and is written as consistently as possible to the matching samples in the pyc10 and pyi106 sample directories. The visual studio project files are in the vs directory at the top of the c directory structure. Make sure samples/ |
| - | < | + | |
| - | </ | + | Once dependencies are installed you should be able to build binaries of the samples. The video sample depends on the mplayer executable (included) located relative to the build and debug directories, |
| - | </ | + | |
| + | All of the samples (again, excluding video since it's a full GUI application) are run from the command line. Each one supports the --help option to view usage, options, etc. for that specific tool. | ||
| + | |||
| + | **Building and Running (Python samples)** | ||
| + | |||
| + | Once python and any other dependencies are installed the python samples can be run at the command prompt by prefixing the invocation with "python" | ||
| + | |||
| + | -------- | ||
| + | ===== APPENDIX ===== | ||
| + | |||
| + | ==== CR031 - XML Mapping to Chapter 10 ==== | ||
| - | <!-- Structured | + | It was decided during a Recorder Vendor Working Group telecon to push CR031 into an appendix of the next release of the programmer' |
| - | < | + | |
| - | < | + | |
| - | + | ||
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | + | ||
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | + | ||
| - | <!-- Any data can be inserted in between --> | + | |
| - | < | + | |
| - | + | ||
| - | < | + | |
| - | < | + | |
| - | </ | + | |
| - | + | ||
| - | </ | + | |
| - | </ | + | |
| - | < | + | |
| - | + | ||
| - | </ | + | |
| - | </ | + | [[CR31 - XML Sample File]] |
ch10_13_handbook/start.1407793310.txt.gz · Last modified: 2014/08/11 16:41 by pferrill