Joule
  • Welcome to Joule's Docs
  • Why Joule?
    • Joule capabilities
  • What is Joule?
    • Key features
    • The tech stack
  • Use case enablement
    • Use case building framework
  • Concepts
    • Core concepts
    • Low code development
    • Unified execution engine
    • Batch and stream processing
    • Continuous metrics
    • Key Joule data types
      • StreamEvent object
      • Contextual data
      • GeoNode
  • Tutorials
    • Getting started
    • Build your first use case
    • Stream sliding window quote analytics
    • Advanced tutorials
      • Custom missing value processor
      • Stateless Bollinger band analytics
      • IoT device control
  • FAQ
  • Glossary
  • Components
    • Pipelines
      • Use case anatomy
      • Data priming
        • Types of import
      • Processing unit
      • Group by
      • Emit computed events
      • Telemetry auditing
    • Processors
      • Common attributes
      • Filters
        • By type
        • By expression
        • Send on delta
        • Remove attributes
        • Drop all events
      • Enrichment
        • Key concepts
          • Anatomy of enrichment DSL
          • Banking example
        • Metrics
        • Dynamic contextual data
          • Caching architecture
        • Static contextual data
      • Transformation
        • Field Tokeniser
        • Obfuscation
          • Encryption
          • Masking
          • Bucketing
          • Redaction
      • Triggers
        • Change Data Capture
        • Business rules
      • Stream join
        • Inner stream joins
        • Outer stream joins
        • Join attributes & policy
      • Event tap
        • Anatomy of a Tap
        • SQL Queries
    • Analytics
      • Analytic tools
        • User defined analytics
          • Streaming analytics example
          • User defined analytics
          • User defined scripts
          • User defined functions
            • Average function library
        • Window analytics
          • Tumbling window
          • Sliding window
          • Aggregate functions
        • Analytic functions
          • Stateful
            • Exponential moving average
            • Rolling Sum
          • Stateless
            • Normalisation
              • Absolute max
              • Min max
              • Standardisation
              • Mean
              • Log
              • Z-Score
            • Scaling
              • Unit scale
              • Robust Scale
            • Statistics
              • Statistic summaries
              • Weighted moving average
              • Simple moving average
              • Count
            • General
              • Euclidean
        • Advanced analytics
          • Geospatial
            • Entity geo tracker
            • Geofence occupancy trigger
            • Geo search
            • IP address resolver
            • Reverse geocoding
            • Spatial Index
          • HyperLogLog
          • Distinct counter
      • ML inferencing
        • Feature engineering
          • Scripting
          • Scaling
          • Transform
        • Online predictive analytics
        • Model audit
        • Model management
      • Metrics engine
        • Create metrics
        • Apply metrics
        • Manage metrics
        • Priming metrics
    • Contextual data
      • Architecture
      • Configuration
      • MinIO S3
      • Apache Geode
    • Connectors
      • Sources
        • Kafka
          • Ingestion
        • RabbitMQ
          • Further RabbitMQ configurations
        • MQTT
          • Topic wildcards
          • Session management
          • Last Will and Testament
        • Rest endpoints
        • MinIO S3
        • File watcher
      • Sinks
        • Kafka
        • RabbitMQ
          • Further configurations
        • MQTT
          • Persistent messaging
          • Last Will and Testament
        • SQL databases
        • InfluxDB
        • MongoDB
        • Geode
        • WebSocket endpoint
        • MinIO S3
        • File transport
        • Slack
        • Email
      • Serialisers
        • Serialisation
          • Custom transform example
          • Formatters
        • Deserialisers
          • Custom parsing example
    • Observability
      • Enabling JMX for Joule
      • Meters
      • Metrics API
  • DEVELOPER GUIDES
    • Setting up developer environment
      • Environment setup
      • Build and deploy
      • Install Joule
        • Install Docker demo environment
        • Install with Docker
        • Install from source
        • Install Joule examples
    • Joulectl CLI
    • API Endpoints
      • Mangement API
        • Use case
        • Pipelines
        • Data connectors
        • Contextual data
      • Data access API
        • Query
        • Upload
        • WebSocket
      • SQL support
    • Builder SDK
      • Connector API
        • Sources
          • StreamEventParser API
        • Sinks
          • CustomTransformer API
      • Processor API
      • Analytics API
        • Create custom metrics
        • Define analytics
        • Windows API
        • SQL queries
      • Transformation API
        • Obfuscation API
        • FieldTokenizer API
      • File processing
      • Data types
        • StreamEvent
        • ReferenceDataObject
        • GeoNode
    • System configuration
      • System properties
  • Deployment strategies
    • Deployment Overview
    • Single Node
    • Cluster
    • GuardianDB
    • Packaging
      • Containers
      • Bare metal
  • Product updates
    • Public Roadmap
    • Release Notes
      • v1.2.0 Join Streams with stateful analytics
      • v1.1.0 Streaming analytics enhancements
      • v1.0.4 Predictive stream processing
      • v1.0.3 Contextual SQL based metrics
    • Change history
Powered by GitBook
On this page
  • Objective
  • Prerequisites
  • Processing Overview
  • Development steps

Was this helpful?

  1. Tutorials
  2. Advanced tutorials

IoT device control

PreviousStateless Bollinger band analyticsNextFAQ

Last updated 3 months ago

Was this helpful?

Objective

In the realm of Internet of Things (IoT), proactive adaptive control has emerged as the norm for managing remote devices. This case study presents a practical application of IoT in addressing low growth yields. It employs streaming sensor measurements, analytics, and control logic to devise a solution.

The scenario presents a mushroom grower encountering difficulties in optimising their production environment for mushroom cultivation. This is primarily attributed to the unpredictable fluctuations in temperature, humidity, and carbon dioxide levels, which severely disrupt optimal conditions for mushroom growth.

The objective is to automate the control of airflow valves to an optimal growing environment for each connected growing module.

Two key functions are required

  1. Increase production output by optimising an independent growing module

  2. Ensure heat, humidity and carbon dioxide levels remain optimal in each growing module

Prerequisites

To get started building a custom processor ensure you have your development environment configured. Read the documentation to get your environment ready to build.

Processing Overview

For a very simple processing overview sensor measurements are generated and published onto the sensors/data MQTT topic, processed and then published on to the management_units topic ready for valve controller to switch on or off the humidity ventilation unit.

Development steps

1

Setup environment

Within the “quickstart” folder, all the necessary files to execute the demonstration have been deployed. The configuration, parser, and transformer files are located in the “iot-demo” directory.

  1. Install tools

  2. Start Joule container

  3. Setup the sensor simulator environment

  4. Validate MQTT is running

Install tools

Python - Python is used for the sensor simulator.

curl - curl is used to execute Rest Joule API commands for transport registration, use case deployment etc.

Optional - Developer environment To extend the demo you will need to install the

Start Joule container

Run the below command to start up the Joule environment.

./quickstart/startupJoule

Setup the sensor simulator environment

Sensor measurement events are generated using a python simulator. Sensors events are published on to the MQTT sensors/data topic as a JSON payload which is then parsed in to the Joule StreamEvent object ready for processing.

Sensor Event

The sensor measurement schema:

- eventTime
- sensorId
- temperature
- humidity
- co2
- mqValue

Example

{
  "sensorId": 1001,
  "eventTime": 1735767588478,
  "temperature": 33.0,
  "humidity": 12.3,
  "co2": 12.2,
  "mqValue": 25
}

To use the simulator, the executing environment must be prepared for its intended use.

cd ./quickstart/bin/iot/sensor_simulator

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r requirements.txt

Validate MQTT is running

Now validate messages can be sent and received using the running mqtt container.

Subscriber

mosquitto_sub -h localhost -t sensors/data

Publisher

mosquitto_pub -h localhost -t sensors/data -m "{\"sensorId\":1001,\"eventTime\":1735767588478,\"temperature\":33.0,\"humidity\":12.3,\"co2\":12.2}"

If all of this is working you are now ready to deploy a use case.

2

Deploy use case

To deploy the use case, simply execute the following commands on the command line.

Valve Control

This forms the base functionality of the use case.

./quickstart/bin/iot/deployValveControlUsecase

Audited Valve Control

This use case adds auditing to the processing stream. Joule records both the incoming outgoing events within the embedded in-memory database.

./quickstart/bin/iot/deployAuditedUsecase
3

Monitor output

Subscribe to the Joule MQTT output topic

mosquitto_sub -h localhost -t management_units

Example output

Output generation is triggered when the logic within the JavaScript function “turnONorOFF” is executed. At a minimum, events are generated every 30 seconds, as defined within the tumbling window function.

The output value of 1 corresponds to an 'on' valve signal, while 0 corresponds to an 'off' valve signal.

{
  "eventTime": 1738709444907,
  "sensorId": 1001,
  "valve_signal": 1
}

Output events are also published to a local file.

tail -F data/output/activatations/sensor_activations.csv
4

Export audit data

The audit use case captures all raw and processed data. Joule records both the incoming outgoing events within the embedded in-memory database.

./quickstart/bin/iot/exportData --stream 'audited_sensor_analytics' --table 'raw' --from '2025-01-10 16:00:00' --to '2025-01-10 23:00:00' --filepath 'data/test.parquet' --format 'parquet'"
5

Undeploy

To undeploy a use case and its artefacts a utility script has been provided which takes a use case name as an argument.

./quickstart/bin/iot/undeploy --usecase valve_control_uc

environment setup
Official python downloads
Example install directions
supported developer environment.