Viewing is open to everyone. Downloading and starring need a GitHub sign-in.
Sign in with GitHub
CKey-Format-v0.7.0.md
v0.1.0-build.85
Latest
Commit ede38f5
Sign in with GitHub to download. Each download is recorded with your GitHub username.
| 1 | # CKey locator format v0.7.0 (draft) |
| 2 | |
| 3 | Status: experimental implementation profile. Wire and geometry constants are versioned as `format=7, profile=1`; interoperability is not promised until decoder fixtures pass in independent implementations. |
| 4 | |
| 5 | ## 1. Coordinate system and symbol shape |
| 6 | |
| 7 | The canonical symbol field is 29 × 29 module units. The origin is the upper-left; x increases right and y increases down. Its center is `(14.5, 14.5)`. A 0.65-unit rounded square boundary runs from `(0.5,0.5)` to `(28.5,28.5)` with radius 3.5. Each corner finder is three concentric quarter-arcs with centerline radii 3.0, 3.75, and 4.5 units and stroke width 0.42, all with round caps. The top-left center is exactly `(0.8,0.8)`; the top-right, bottom-right, and bottom-left centers are the corresponding reflections `(28.2,0.8)`, `(28.2,28.2)`, and `(0.8,28.2)` across the 29-unit field. Bottom-left, top-right, and bottom-right sets contain three continuous arcs. Each top-left arc is split into two pieces; the gap is centered at 45° and has one module of clear visible space after accounting for round caps. The three arcs and their gaps form the orientation finder. The gap is an orientation cue, not a payload site. Each 6 × 6 corner region (module indices 0–5 or 23–28 on each axis) is reserved from payload. This envelope includes the finder stroke and prevents nearby matrix cells from touching it. Boundary and finder geometry are structural and take precedence over other layers. These dimensions remain fixed for profile 1. |
| 8 | |
| 9 | The polar angle `a` is clockwise from 12:00. There are 72 angular slots per turn, each exactly 5 degrees. Four inner concentric data rings have radii 3.6, 4.4, 5.2, and 6.0 units. Polar point `(ring, slot)` has radius `3.6 + 0.8 × ring` for rings 0 through 3, and center |
| 10 | |
| 11 | `x = 14.5 + radius × sin(2π × slot / 72)` |
| 12 | `y = 14.5 − radius × cos(2π × slot / 72)`. |
| 13 | |
| 14 | The dial is a separate narrow annulus from radius 7.6 to 9.5 units. Its 72 angular slots contain short radial data ticks; no tick extends toward the center. The symbol is monochrome. The reference renderer uses a dark background and light marks; a decoder must normalize either contrast polarity from image evidence. Color never changes interpretation. Reference SVG colors `#050505` and `#f4f1e8` are decorative only. |
| 15 | |
| 16 | ## 2. Permanent calibration keys |
| 17 | |
| 18 | These are reserved structures and cannot be payload sites. |
| 19 | |
| 20 | * **Grid Key:** A fixed 2 × 2 block occupies columns 2–3 and rows 11–12. All four rounded-square cells are dark. Their known spacing calibrates Cartesian pitch and verifies local grid alignment. |
| 21 | * **Ray Key:** Rays occupy only the dial annulus. Slot 0 (12:00) spans radius 7.6–9.5; slot 54 (9:00) spans the inner half, 7.6–8.55; adjacent slot 55 (9:05) spans the inner 75%, 7.6–9.025. None touches the center. |
| 22 | * **Ring Key:** On inner ring 3 (radius 6.0), slots 18 and 19 are individual dots; slot 20 is explicitly empty; slot 21 is one individual dot; slots 22–25 are one connected, continuous four-slot arc. Dots are centered on their slot bearings. Every ring dot and Ring Key dot has the same diameter, 0.30 module units (radius 0.15), independent of ring radius. At the innermost radius 3.6, the adjacent-slot chord is approximately 0.314 units, leaving a 0.014-unit visible gap. The arc has stroke width 0.30 units and round caps. Its visible curved length, measured along the arc including the rounded terminal extensions, equals four angular slot pitches at radius 6.0. The centerline is shortened by one dot diameter to compensate for the caps; the straight-line distance between the two tips is shorter because the arc is curved. It is one continuous stroke, not four dots. |
| 23 | |
| 24 | Polar dots and Ring Key dots use a constant 0.30-unit diameter on all four rings. The Ring Key arc uses a 0.30-unit stroke with round ends and a four-slot visible length. Each payload dial slot is always drawn as a radial ray: a 0 bit has length 0.65 units and a 1 bit has length 1.35 units, both measured outward from radius 7.6. Ray widths are 0.15 units with round ends. The three reserved calibration rays retain their specified lengths and 0.22-unit stroke. Other profile 1 rendering dimensions: Cartesian module size 0.74 with corner radius 0.16; boundary stroke width 0.65. Decoder tolerances are not yet specified, so camera support is not claimed. |
| 25 | |
| 26 | The three keys are jointly required for calibration/orientation validation. A missing or inconsistent key must be a decode failure, not treated as an empty payload site. |
| 27 | |
| 28 | ## 3. Locator framing and integrity |
| 29 | |
| 30 | The locator payload is exactly 16 arbitrary bytes. Its 26-byte data frame is: |
| 31 | |
| 32 | | Offset | Length | Meaning | |
| 33 | |---:|---:|---| |
| 34 | | 0 | 2 | Magic bytes `C7 4B` | |
| 35 | | 2 | 1 | Format version `07` | |
| 36 | | 3 | 1 | Profile `01` (locator) | |
| 37 | | 4 | 2 | Payload length, unsigned big-endian (`00 10`) | |
| 38 | | 6 | 16 | Payload bytes, unchanged | |
| 39 | | 22 | 4 | CRC-32C of bytes 0–21, unsigned big-endian | |
| 40 | |
| 41 | CRC-32C uses reflected Castagnoli polynomial `0x82F63B78`, initial value `0xFFFFFFFF`, reflected input/output, and final XOR `0xFFFFFFFF`. |
| 42 | |
| 43 | The frame is encoded as a shortened systematic Reed–Solomon code RS(77,26) over GF(256), primitive polynomial `0x11D`, primitive element 2, generator roots `α^0` through `α^50`, transmitted high-degree coefficient first. Append 51 parity bytes after the frame. This code has the algebraic bound `2e + s ≤ 51` (up to 25 unknown byte errors or 51 known erasures). The implementation corrects unknown byte errors through the full `e ≤ 25` bound in deterministic test patterns. Erasure decoding is not implemented, so the `s` portion is a code capability, not a current decoder claim. |
| 44 | |
| 45 | ## 4. Placement and reserved geometry |
| 46 | |
| 47 | The 77-byte codeword is read MSB-first, yielding 616 bits. A light mark represents 1 and background represents 0. Payload/ECC bits are mapped over eligible Cartesian and polar sites in alternating coordinate-system order: take the next Cartesian candidate, then the next polar candidate, and repeat until 616 sites are assigned. For each Cartesian candidate, compute `a=atan2(x−14.5,14.5−y)` in `[0,2π)` and assign `sector=round(72a/(2π)) mod 72` (nearest 5° sector, half ties away from zero). Within each sector sort by decreasing squared radius `(x−14.5)²+(y−14.5)²`, then by ascending row and column. Visit sectors in rounds using `sector=(37×step) mod 72`. Polar sites place all 69 dial data slots first, in `slot=(37×step) mod 72` order, so every variable-length ray is encoded. Inner ring `l` (0–3) then visits `slot=(37×step+13×(l+1)) mod 72`, skipping reserved keys; the four inner rings are traversed round-robin by site index. The final placement alternates one Cartesian then one polar candidate, starting with Cartesian, and appends any remainder from the non-exhausted list. The profile has 284 Cartesian and 337 polar eligible sites (621 total); unassigned sites remain background. No payload-bearing site may overlap a finder, boundary, Grid Key, Ray Key, or Ring Key. |
| 48 | |
| 49 | Cartesian candidates are cell centers in rows and columns 1–27, excluding the four reserved 6 × 6 corner regions, the 2 × 2 Grid Key at rows 11–12/columns 2–3, and every cell center at radius ≤10.4 units from the symbol center. Polar candidates include four inner ring centers per available angular slot, excluding Ray Key bearings on all rings and Ring Key slots 18–25 on inner ring 3. Dial candidates occupy the same 72 angular slots in the annulus, excluding the three Ray Key bearings. A dial data mark is a radial tick beginning at radius 7.6. Each of the 69 data-bearing dial slots is always marked: bit 0 has length 0.65 units and bit 1 has length 1.35 units. These ranges are disjoint from the fixed calibration rays in slots 0, 54, and 55. Absence is not a data state. The logo-safe area is the center inside radius 3.3 and contains no payload sites. No logo may cover any required structure or assigned payload/ECC mark. |
| 50 | |
| 51 | The normalized geometry is shared; vector rendering uses continuous polar coordinates while Cartesian elements remain rounded square cells. The native image decoder must rectify the outer square before sampling both coordinate systems. v0.7.0 does not yet define a camera-validity envelope or decoder tolerances. Camera decoding of this rendered profile has not been implemented or validated. |
| 52 | |
| 53 | ## 5. Example |
| 54 | |
| 55 | For payload bytes `00 01 02 … 0F`, the format-7 frame CRC-32C and RS parity are recorded in the versioned fixture [`tests/vectors/locator-v7.json`](../tests/vectors/locator-v7.json). Earlier format documents and fixtures remain as historical draft records. |
| 56 | |
| 57 | ## 6. Known omissions before stabilization |
| 58 | |
| 59 | The next format revision must specify decoder tolerances for line width, dot diameter, arc connectivity/gap, geometric fit residuals, reflections, and distortion; full RS decode and erasures; every-version capacity accounting; and independent implementation fixtures. This draft has one locator profile only. It does not claim a general 2,048-byte profile. |