OXRS Docs

Digital IO ESP32/ESP8266

by OXRS Core Team

SKU: OXRS-IO-DigitalIO-ESP-FW

Introduction

This FW is similar to OXRS-SHA-StateIO-ESP32 which combines the functionality of OXRS-SHA-StateMonitor-ESP32 and OXRS-SHA-StateController-ESP32.

The major difference of DigitalIO compared to StateIO is the usage of spare GPIO pins of an ESP32/ESP8266 to perform physical IO instead of I2C connected IO-expander.

By default all GPIOs are configured as input.

How does it work?

The 16 available GPIOs on an ESP32 are;

2, 4, 5, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 25, 26, 27

The 8 available GPIOs on an ESP8266 are;

2, 4, 5, 12, 13, 14, 15, 16

Each GPIO can be individually configured to be either monitor inputs or control outputs.

The AdminUI-WEB-APPopen in new window is the ideal tool to set and save your desired configuration.

TIP

  • Inputs are configured with internal pullup and are LOW active
  • Outputs are LOW active
  • This FW runs on WiFi only

Possible use cases

  • Runs on an off the shelf ESP32/ESP8266 dev boards without any additional peripherals
  • Supports the standard OXRS eco-system so it can be used for bench testing to get familiar with the api without the need to have a RACK32 on hand
  • Push buttons, switches, encoder, relay driver ... can be connected for a small scale applications or testing

Configuration

This FW is fully compatible with OXRSopen in new window eco-system and is built using the standard OXRS Libraries

All the functionality of the StateMonitor applies to input GPIOs and StateController functionality applies to output GPIOs. Please see their documentation for further details.

TIP

Instead of using the index to address the IO-pin, the gpio number is used for convenience. These numbers have to be used in all /cmnd requests and are returned in all /stat updates. Beside this change the API is equal to StateMonitor/StateController to ensure compatability with the IO-expander HW.

The configuration payloads are wrapped in an extra JSON object, containing the GPIO pin and type. The payloads inside the input and output objects mirror the format in the StateMonitor and StateController firmware. The only exception is interlockGpio which is named interlockIndex in the State Controller firmware.

{
  "gpios": [
    {
      "gpio": 2,
      "type": "input",
      "input": { "type": "contact", "invert": true }
    },
    {
      "gpio": 4,
      "type": "input",
      "input": { "type": "button" }
    },
    {
      "gpio": 19,
      "type": "output",
      "output": { "type": "timer", "timerSeconds": 5 }
    },
    {
      "gpio": 21,
      "type": "output",
      "output": { "type": "motor", "interlockGpio": 22 }
    },
    {
      "gpio": 22,
      "type": "output",
      "output": { "type": "motor", "interlockGpio": 21 }
    }
  ]
}

Downloads

Download the latest binaryopen in new window of the firmware from GitHub.

Download the source codeopen in new window of the firmware from GitHub.

Supported Hardware

Any ESP32 or ESP8266 with all GPIOs broken out and not connected to or used by additional hardware.

Is designed to run as part of the OXRSopen in new window eco-system.

Credits

License

Copyright 2020-present SuperHouse Automation Pty Ltd www.superhouse.tv

The software portion of this project is licensed under the Simplified BSD License. The "licence" folder within this project contains a copy of this license in plain text format.