https://github.com/tetherto/miningos-tpl-wrk-sensor
https://github.com/tetherto/miningos-tpl-wrk-sensor
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tetherto/miningos-tpl-wrk-sensor
- Owner: tetherto
- Created: 2026-01-07T12:28:58.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-04-22T17:26:28.000Z (3 months ago)
- Last Synced: 2026-04-22T19:24:48.778Z (3 months ago)
- Language: JavaScript
- Size: 201 KB
- Stars: 0
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# miningos-tpl-wrk-sensor
## Table of Contents
1. [Overview](#overview)
2. [Object Model](#object-model)
3. [Architecture](#architecture)
## Overview
`miningos-tpl-wrk-sensor` is an **abstract base worker** for sensor devices in the MiningOS Bitcoin mining infrastructure ecosystem. This template provides the foundation for implementing concrete sensor workers (temperature, humidity, etc.) that are critical for monitoring and maintaining optimal mining operations.
### Key Characteristics
- **Abstract Template**: Serves as base class for concrete sensor implementations
- **Real-Time Data Collection**: Collects sensor readings every 10 seconds via scheduled stats
- **Distributed Architecture**: Supports rack-based sharding for horizontal scaling
- **RPC Communication**: Full-featured RPC interface for remote management
- **Hypercore Storage**: Uses Hyperbee for efficient time-series data storage
- **Alert System**: Built-in alert processing and monitoring capabilities
## Object Model
The following is a fragment of [MiningOS object model](https://docs.mos.tether.io/) that contains the concrete class representing **Sensor workers** (highlighted in blue). The rounded nodes reprsent abstract classes and the square nodes represents a concrete classes:
```mermaid
---
title: Object Model of MiningOS
---
flowchart RL
bfx-wrk-base@{ shape: stadium, label: "*bfx-wrk-base*" }
tether-wrk-base@{ shape: stadium, label: "*tether-wrk-base*" }
tether-wrk-base--->bfx-wrk-base
miningos-tlp-wrk-thing@{ shape: stadium, label: "*miningos-tlp-wrk-thing*" }
miningos-tlp-wrk-thing--->tether-wrk-base
miningos-tpl-wrk-sensor@{ shape: stadium, label: "*miningos-tpl-wrk-sensor*" }
miningos-tpl-wrk-sensor--->miningos-tlp-wrk-thing
miningos-wrk-sensor-temp-seneca["miningos-wrk-sensor-temp-seneca"]
miningos-wrk-sensor-temp-seneca--->miningos-tpl-wrk-sensor
style miningos-tpl-wrk-sensor fill:#005,stroke-width:4px,color:white
```
Check out [miningos-tpl-wrk-container](https://github.com/tetherto/miningos-tpl-wrk-container) for more information about parent classes.
## Architecture
### BaseSensor Class (`workers/lib/base.js`)
The core sensor abstraction class that extends `BaseThing` from the parent template.
**Key Features:**
- **Real-Time Data**: `getRealtimeData()` method for frequent polling
- **Snap Preparation**: Calls `_prepSnap()` for data collection
### WrkSensorRack Class (`workers/rack.sensor.wrk.js`)
The main worker orchestrator that manages sensor lifecycle and data collection.
**Key Features:**
- **Real-Time Data Scheduling**: Collects data every 10 seconds (`rtd` schedule)
- **Thing Type Definition**: Identifies as 'sensor' type
- **Stats Integration**: Defines sensor-specific statistics operations
**Configuration:**
```javascript
scheduleAddlStatTfs = [
['rtd', '*/10 * * * * *'] // Real-time data every 10 seconds
]
```