# open-source-range/osr_gps_collar architecture

> Architecture diagram of the GitHub repository open-source-range/osr_gps_collar, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/open-source-range/osr_gps_collar
- Repository: https://github.com/open-source-range/osr_gps_collar

## Overview

This repository is an open-source, low-cost GPS tracking collar for livestock. Its principal workflow is to construct and power a collar, run embedded firmware to collect GPS telemetry and record it, then process or merge the resulting files for analysis. The README documents the main device components and versioned design areas; the tree shows versioned firmware and data scripts. Connections below are based on README statements, not inspection of those unsampled modules.

Main entry points: [`Data`](https://github.com/open-source-range/osr_gps_collar/tree/master/Data) (Recorded GPS files), [`Hardware`](https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware) (Tracker electronics), [`Battery`](https://github.com/open-source-range/osr_gps_collar/tree/master/Battery) (Battery options), [`Firmware/v1`](https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v1) (Version 1 firmware)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_device["Tracker hardware"]
  node_hardware["Tracker electronics"]
  node_hardware_v1["Version 1 design"]
  node_hardware_v2["Version 2 design"]
  node_hardware_v3["Version 3 design"]
  node_battery["Battery options"]
end

subgraph group_embedded["Embedded tracking"]
  node_firmware_v1["Version 1 firmware"]
  node_firmware_v2["Version 2 firmware"]
  node_firmware_v3["Version 3 firmware"]
end

subgraph group_deployment["Collar deployment"]
  node_assembly["Assembly instructions"]
  node_housing["Device housing"]
  node_collar["Livestock collar"]
end

subgraph group_data["Telemetry data"]
  node_recorded_files[("Recorded GPS files")]
  node_v1_processing["COTS data processing"]
  node_v2_merge["Version 2 file merge"]
  node_v3_merge["Version 3 file merge"]
  node_power_analysis["Power analysis<br/>[analyze.py]"]
end

node_builder(("Builder / deployer"))
node_gps["UBLOX GPS"]
node_storage[("SD / flash storage")]

node_builder -->|"follows build steps"| node_assembly
node_builder -->|"constructs"| node_collar
node_assembly -->|"documents assembly"| node_hardware
node_hardware -->|"has version"| node_hardware_v1
node_hardware -->|"has version"| node_hardware_v2
node_hardware -->|"has version"| node_hardware_v3
node_builder -->|"selects power"| node_battery
node_firmware_v1 -->|"acquires locations"| node_gps
node_firmware_v2 -->|"acquires locations"| node_gps
node_firmware_v3 -->|"acquires locations"| node_gps
node_firmware_v1 -->|"records telemetry"| node_storage
node_firmware_v2 -->|"records telemetry"| node_storage
node_firmware_v3 -->|"records telemetry"| node_storage
node_battery -->|"powers device"| node_firmware_v1
node_battery -->|"powers device"| node_firmware_v2
node_battery -->|"powers device"| node_firmware_v3
node_builder -->|"chooses housing"| node_housing
node_builder -->|"assembles collar"| node_collar
node_storage -->|"produces files"| node_recorded_files
node_recorded_files -->|"processes COTS data"| node_v1_processing
node_recorded_files -->|"merges files"| node_v2_merge
node_recorded_files -->|"merges files"| node_v3_merge
node_recorded_files -->|"analyzes power data"| node_power_analysis

click node_assembly "https://github.com/open-source-range/osr_gps_collar/tree/master/Assembly"
click node_hardware "https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware"
click node_hardware_v1 "https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware/v1"
click node_hardware_v2 "https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware/v2"
click node_hardware_v3 "https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware/v3"
click node_battery "https://github.com/open-source-range/osr_gps_collar/tree/master/Battery"
click node_firmware_v1 "https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v1"
click node_firmware_v2 "https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v2"
click node_firmware_v3 "https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v3"
click node_housing "https://github.com/open-source-range/osr_gps_collar/tree/master/Housing"
click node_collar "https://github.com/open-source-range/osr_gps_collar/tree/master/Collar"
click node_recorded_files "https://github.com/open-source-range/osr_gps_collar/tree/master/Data"
click node_v1_processing "https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V1/process_COTS_collar_data.R"
click node_v2_merge "https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V2/2019_GPS_Collar_File_Merge.R"
click node_v3_merge "https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V3/2020_GPS_Collar_File_Merge.R"
click node_power_analysis "https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V3/Power%20Consumption/analyze.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_hardware,node_hardware_v1,node_hardware_v2,node_hardware_v3,node_battery toneBlue
class node_firmware_v1,node_firmware_v2,node_firmware_v3,node_storage toneAmber
class node_assembly,node_housing,node_collar toneMint
class node_recorded_files,node_v1_processing,node_v2_merge,node_v3_merge,node_power_analysis toneRose
class node_builder,node_gps toneIndigo
```

## Components

### Tracker hardware

- [Tracker electronics](https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware): `Hardware`
- [Version 1 design](https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware/v1): `Hardware/v1`
- [Version 2 design](https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware/v2): `Hardware/v2`
- [Version 3 design](https://github.com/open-source-range/osr_gps_collar/tree/master/Hardware/v3): `Hardware/v3`
- [Battery options](https://github.com/open-source-range/osr_gps_collar/tree/master/Battery): `Battery`

### Embedded tracking

- [Version 1 firmware](https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v1): `Firmware/v1`
- [Version 2 firmware](https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v2): `Firmware/v2`
- [Version 3 firmware](https://github.com/open-source-range/osr_gps_collar/tree/master/Firmware/v3): `Firmware/v3`

### Collar deployment

- [Assembly instructions](https://github.com/open-source-range/osr_gps_collar/tree/master/Assembly): `Assembly`
- [Device housing](https://github.com/open-source-range/osr_gps_collar/tree/master/Housing): `Housing`
- [Livestock collar](https://github.com/open-source-range/osr_gps_collar/tree/master/Collar): `Collar`

### Telemetry data

- [Recorded GPS files](https://github.com/open-source-range/osr_gps_collar/tree/master/Data): `Data`
- [COTS data processing](https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V1/process_COTS_collar_data.R): `Data/V1/process_COTS_collar_data.R`
- [Version 2 file merge](https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V2/2019_GPS_Collar_File_Merge.R): `Data/V2/2019_GPS_Collar_File_Merge.R`
- [Version 3 file merge](https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V3/2020_GPS_Collar_File_Merge.R): `Data/V3/2020_GPS_Collar_File_Merge.R`
- [Power analysis](https://github.com/open-source-range/osr_gps_collar/blob/master/Data/V3/Power%20Consumption/analyze.py): `Data/V3/Power Consumption/analyze.py`

### Other components

- **Builder / deployer**
- **UBLOX GPS**
- **SD / flash storage**

## Connections

- Builder / deployer → Assembly instructions: follows build steps (evidence: `README.md`)
- Builder / deployer → Livestock collar: constructs (evidence: `README.md`)
- Assembly instructions → Tracker electronics: documents assembly (evidence: `README.md`)
- Tracker electronics → Version 1 design: has version (evidence: `README.md`)
- Tracker electronics → Version 2 design: has version (evidence: `README.md`)
- Tracker electronics → Version 3 design: has version (evidence: `README.md`)
- Builder / deployer → Battery options: selects power (evidence: `README.md`)
- Version 1 firmware → UBLOX GPS: acquires locations (evidence: `README.md`)
- Version 2 firmware → UBLOX GPS: acquires locations (evidence: `README.md`)
- Version 3 firmware → UBLOX GPS: acquires locations (evidence: `README.md`)
- Version 1 firmware → SD / flash storage: records telemetry (evidence: `README.md`)
- Version 2 firmware → SD / flash storage: records telemetry (evidence: `README.md`)
- Version 3 firmware → SD / flash storage: records telemetry (evidence: `README.md`)
- Battery options → Version 1 firmware: powers device (evidence: `README.md`)
- Battery options → Version 2 firmware: powers device (evidence: `README.md`)
- Battery options → Version 3 firmware: powers device (evidence: `README.md`)
- Builder / deployer → Device housing: chooses housing (evidence: `README.md`)
- Builder / deployer → Livestock collar: assembles collar (evidence: `README.md`)
- SD / flash storage → Recorded GPS files: produces files (evidence: `README.md`)
- Recorded GPS files → COTS data processing: processes COTS data (evidence: `README.md`)
- Recorded GPS files → Version 2 file merge: merges files (evidence: `README.md`)
- Recorded GPS files → Version 3 file merge: merges files (evidence: `README.md`)
- Recorded GPS files → Power analysis: analyzes power data (evidence: `README.md`)
