integration_instructions Community Edition documentation

GreenThinx Community Edition for Home Assistant

The GreenThinx Community Edition custom component connects compatible GreenThinx soil sensors to Home Assistant, so you can monitor soil moisture, soil temperature and root-zone status inside your own dashboards and automations.

View GitHub repository Join Discord

Key features

straighten

Per-depth monitoring

Moisture percentage and soil temperature sensors for each available depth channel, such as 10 cm, 20 cm or 30 cm.

layers

Soil profiles

Configure soil types such as sandy loam, clay, potting soil or peat/coco mix to apply suitable moisture thresholds.

psychiatry

Root-zone status

Aggregate a configurable depth range into a clear status: Optimal, Too dry or Too wet.

tune

Dynamic configuration

Change soil type, root-zone depth and polling interval from the Home Assistant integration options.

Requirements

  • Home Assistant 2023.10 or later
  • Python 3.11 or later, provided by Home Assistant
  • Compatible GreenThinx soil sensor hardware
  • Sensor reachable from your Home Assistant network

The integration is designed for GreenThinx soil sensors with multi-depth capability. Two, three or more simultaneous depth measurements can be represented when available from the device.

Installation

extension Recommended

Option 1: HACS

  1. Open HACS in Home Assistant.
  2. Go to Integrations and open Custom repositories.
  3. Add https://github.com/chaanstra/GTX-CE-HACS.
  4. Search for GreenThinx Community Edition and install it.
  5. Restart Home Assistant.

Option 2: Manual installation

  1. Download the greenthinx_ce folder from the repository.
  2. Copy it into config/custom_components/.
  3. Restart Home Assistant.
  4. Add the integration from Settings, Devices & Services.

Configuration

Initial setup

  1. Go to Settings, Devices & Services.
  2. Click Add Integration and search for GreenThinx Community Edition.
  3. Enter your Sensor ID from the device or GreenThinx app.
  4. Select your soil type, for example sandy loam or potting soil.
  5. Submit the setup flow.

Options

  • Soil type: changes moisture thresholds.
  • Root zone start: default top depth is 10 cm.
  • Root zone end: default bottom depth is 30 cm.
  • Polling interval: default is 300 seconds.

Usage and entities

Entity Type Description
sensor.greenthinx_depth_X_moistureSensorMoisture percentage at depth X.
sensor.greenthinx_depth_X_temperatureSensorSoil temperature at depth X.
sensor.greenthinx_depth_X_soil_statusSensorStatus at depth X: Too dry, Optimal or Too wet.
sensor.greenthinx_root_zone_soil_statusSensorAggregated status for the configured root zone.

Root-zone attributes

The root-zone sensor can expose attributes such as soil type, depths used, minimum moisture, maximum moisture, average moisture and average temperature.

The overall status is based on the most important condition in the configured root-zone range, so one dry depth can mark the root zone as Too dry.

Supported soil types

Clay, light clay, silty clay, silty loam, sandy loam, loamy sand, sand, potting soil, peat/coco mix and custom threshold profiles.

Automation examples

Water alert when root zone is dry

automation:
  - alias: "GreenThinx - Water Plant Alert"
    trigger:
      platform: state
      entity_id: sensor.greenthinx_root_zone_soil_status
      to: "Too dry"
    action:
      - service: notify.mobile_app_phone
        data:
          message: "Plant is too dry. Time to water."

High soil temperature alert

automation:
  - alias: "GreenThinx - High Temperature Alert"
    trigger:
      platform: numeric_state
      entity_id: sensor.greenthinx_depth_1_temperature
      above: 30
    action:
      - service: notify.persistent_notification
        data:
          message: "Soil temperature is above 30 deg C."

Dashboard starter

Use this compact Lovelace structure as a starting point for a soil overview dashboard.

title: GreenThinx Soil Monitoring
views:
  - title: Soil Overview
    path: soil
    icon: mdi:sprout
    cards:
      - type: entities
        show_header_toggle: false
        entities:
          - entity: sensor.greenthinx_root_zone_soil_status
            name: Root zone soil status
          - entity: sensor.greenthinx_depth_1_moisture
            name: 10 cm moisture
          - entity: sensor.greenthinx_depth_2_moisture
            name: 20 cm moisture
          - entity: sensor.greenthinx_depth_3_moisture
            name: 30 cm moisture
          - entity: sensor.greenthinx_depth_1_temperature
            name: 10 cm temperature

Troubleshooting

Integration not appearing

Check that the greenthinx_ce folder is in config/custom_components, then restart Home Assistant and review the logs.

Sensor ID not recognized

Check the device label, GreenThinx app device information or the device web interface if available.

No data or unavailable state

Verify that the GreenThinx device is online, reachable from Home Assistant and already collecting data.

Incorrect moisture status

Confirm the selected soil type, sensor placement and calibration before relying on status thresholds.

For detailed errors, check Settings, System, Logs in Home Assistant or create an issue on the GTX-CE-HACS GitHub repository.

Community Edition note

GreenThinx Community Edition is intended for community testing, personal use and feedback. Review the repository notes before installation, and use it carefully in automations that affect real irrigation hardware.

 Apply as a beta tester