@tetherto/miningos-tpl-wrk-sensor

miningos-tpl-wrk-sensor

Table of Contents

• Overview
• Object Model
• 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 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:

---
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 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:

scheduleAddlStatTfs = [
  ['rtd', '*/10 * * * * *']  // Real-time data every 10 seconds
]