ReengineeringPage » History » Version 1
Anonymous, 04/22/2017 04:04 PM
Initial draft of Re-engineering Page
| 1 | 1 | = Re-engineering OP25 = |
|
|---|---|---|---|
| 2 | |||
| 3 | Since we first started on OP25 there has been a long hiatus during which GNURadio has evolved and this has caused a lot of problems. This page is the top-level for the re-engineering effort. |
||
| 4 | |||
| 5 | == Re-engineering and Refactoring goals == |
||
| 6 | |||
| 7 | There are a number of top-level goals for this exercise. Most obviously we want the code to work on GNURadio 3.6 but there are many subtasks: |
||
| 8 | |||
| 9 | * Move to cmake for the build. |
||
| 10 | * Rename components consistently using the new namespace rules. |
||
| 11 | We can use the new |
||
| 12 | * [RefactoringPage Refactoring so we have top-level encoder/decoder blocks but expose lower-level blocks (e.g. P25 correlator, P25 error corrector, IMBE vocoder, etc.) and make use of new features as appropriate.] |
||
| 13 | * Remove dependency on obsolete interfaces. |
||
| 14 | * Remove dependency on problematic external code for build: |
||
| 15 | * Remove dependency on IT++ (write our own error-correction code instead). |
||
| 16 | * Remove dependency on Frank's demod (pretty much done). |
||
| 17 | * Revise the p25cai encapsulation protocol (the radiotap-like structure sucks) and ensure that OP25 and wireshark use it properly. |
||
| 18 | |||
| 19 | To keep the work to a reasonable minimum we can focus stage one on just the core blocks and use GRC to implement a transceiver and receiver. |
||
| 20 | |||
| 21 | == Tickets == |
||
| 22 | |||
| 23 | Work will be managed using the trac ticket system. Every re-development activity will have an associated ticket so we can track progress. |
||
| 24 | |||
| 25 | == Source Code == |
||
| 26 | |||
| 27 | We'll make the work-in-progress available on the trunk of the normal OP25 repository. For now we'll just use a new "refactoring" subdirectory to act as the top-level of the re-engineered codebase. |
||
| 28 | |||
| 29 | === Unit Tests === |
||
| 30 | |||
| 31 | Open questions: |
||
| 32 | * Use Boost::Test to write unit tests? |
||
| 33 | * Require all blocks to implement make check. |
||
| 34 | Have them call the "real" Boost::Test unit tests or do something else? |
||
| 35 | |||
| 36 | == Managing Discussions == |
||
| 37 | |||
| 38 | This wiki page is intended to be the top-level page for the re-engineering exercise. If we need to work on a proposal we can open a shared wiki page to capture the idea and discuss it via the e-list. |
