Editing Correlate Access Code

[[Category:Block Docs]]
Examine input for specified access code, one bit at a time.
<br><code>Deprecated in 3.8</code>

input: stream of bits, 1 bit per input byte (data in LSB)

output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit)

Each output byte contains two valid bits, the data bit, and the flag bit. The LSB (bit 0) is the data bit, and is the original input data, delayed 64 bits. Bit 1 is the flag bit and is 1 if the corresponding data bit is the first data bit following the access code. Otherwise the flag bit is 0.

== Parameters ==
; Access Code
: is represented with 1 byte per bit, e.g., <code>010101010111000100</code>

:It is important to choose an access code that is not "cyclical".  A cyclical code contains a repetition of itself within the length of the code.  This can cause false access code detections, and will cause byte boundaries (and hence valid packet length and payload recovery) to be recovered in error, with bizarre results!

:For example, an access code of <code>11111111</code> is a poor choice because it is cyclical. Let's look at why this is. 

:The first eight <code>1</code> bits in a row from the block's input stream will correctly detect the first access code.  The first packet (in standard form <code><access code> <length1> <length2> <payload></code>) will be recovered nominally.  

:However, when the correlate access code block's state machine goes back into scanning/detection mode after the first packet, the first bit of the NEXT access code (which forms the <code>11111111</code> preamble of the next packet) will cause an immediate access code detection.  This is because the access code detection routine within the block always shifts the last detected access code one bit to the left, and ORs in the current input bit.

:In our example, the valid bits <code>11111111</code> from the first access code detected will get shifted left one bit (to give <code>11111110</code>), and then the next input bit (the first bit after the end of the first packet) will be ORed into the value (<code>11111110 OR 1</code>, giving <code>11111111</code>) resulting in an erroneous detection of the next access code, because <code>11111111</code> will of course match the access code that the block is searching for.  

:This will falsely detect the start of the next packet (alignment off by 7 bits) and your flowgraph will explode with subsequent bad headers and invalid data.  Not a pretty site.

:So, when choosing an access code, select one that is not cyclical!

:A possible (and historically interesting) non-cyclical 32-bit access code might be 0xe15ae893:

:<code>11100001010110101110100010010011</code>

:which was the "unique word" used on several early communications satellites.


; Threshold
: maximum number of bits that may be wrong

== Example Flowgraph ==

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI.  Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately.  The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

== Source Files ==

; C++ files
: [https://github.com/gnuradio/gnuradio TODO]

; Header files
: [https://github.com/gnuradio/gnuradio TODO]

; Public header files
: [https://github.com/gnuradio/gnuradio TODO]

; Block definition
: [https://github.com/gnuradio/gnuradio TODO]