OpenIndus documentation Logo

Get Started

  • Get Started
    • Hardware Setup
      • System Assembly
        • Rail Types
        • Connecting Rails with USB-C Cables
        • Plugging Modules onto Rails
      • Terminal Block Wiring
      • Power Supply
        • Power Supply Requirements
        • Wiring the Power Supply
        • USB Power
        • Powering Multiple Modules
        • Secondary Power Input
    • Launch your project
      • OpenIndus Modules Overview
      • Environment Installation
        • Visual Studio Code
        • Install OpenIndus VSCode Extension
        • Automatic installation of ESP-IDF
      • Begin with your first project
        • Start a new project
        • Configure your project
        • Build your project
        • Upload your project
        • Monitor your project
      • Start coding
        • Read Digital Input
        • Add one slave device
        • Add several slave devices (with auto ID)
        • Add several slave devices (with serial number)
      • Extension Installation Troubleshooting
    • Arduino & External libraries
      • Use Arduino code
        • Example: Use Ticker to control timing
      • Add external library to the code
        • Arduino libraries
        • Espressif libraries
    • Firmware Update
      • Getting System Information
      • Updating Device Firmware
      • Updating All Slave Devices on the Bus

Modules

  • Modules list
    • OI-Core & OI-CoreLite
      • Description
      • Pinout
      • Functions
    • OI-Discrete
      • Description
      • Pinout
      • Functions
    • OI-Mixed
      • Description
      • Pinout
      • Functions
    • OI-AnalogLS
      • Description
      • Pinout
      • Functions
    • OI-Stepper
      • Description
      • Pinout
      • Functions
    • OI-RelayLP
      • Description
      • Pinout
      • Functions
    • OI-RelayHP
      • Description
      • Pinout
      • Functions
    • OI-Dc
      • Description
      • Pinout
      • Functions

Functions

  • Functions list
    • System
      • Description
        • Execution Flow
        • System Initialization
        • Error Codes
        • Error Handling
      • User Code
        • setup()
        • loop()
      • Complete Example
        • Example with custom error handling
      • System API
        • System
    • Digital Input
      • Description
      • Characteristics
      • Code examples
      • Software API
        • DigitalInputsInterface
    • Digital Output
      • Description
      • Characteristics
      • Code examples
      • Software API
        • DigitalOutputsInterface
    • Analog Input 0-30V
      • Description
      • Characteristics
      • Code examples
      • Software API
        • AnalogInputsHV
    • Analog Input 0-10V or 4-20mA
      • Description
      • Characteristics
        • Voltage mode
        • Current mode
      • Code examples
      • Software API
        • AnalogInputsLV
    • Analog Inputs Low Signal
      • Description
        • Connection example:
      • Characteristics
      • Code examples
        • Example: Reading RTD, Thermocouple and Strain Gauge Simultaneously
        • Example 1: Reading a PT1000 RTD sensor
        • Example 2: Reading a Type K Thermocouple
        • Example 3: Reading a Strain Gauge
      • Software API
        • AnalogInputsLS Class
        • RTD Class
        • Raw Sensor Class
        • Thermocouple Class
        • Strain gauge Class
        • Available Sensor Types
    • Analog Output 0-10V or 4-20mA
      • Description
      • Characteristics
        • Voltage mode
        • Current mode
      • Code examples
      • Software API
        • AnalogOutputs
    • Relay
      • Mechanical Relay
        • Description
        • Characteristics
      • Static Relay
        • Description
        • Characteristics
      • Code examples
      • Software API
        • Relays
    • Stepper Motor
      • Description
      • Characteristics
      • Protections
      • Software Features
      • Operation
        • Homing
        • Speed Control
        • Stop Modes
        • Power Control
        • Configuration
      • Code examples
      • Software API
        • MotorStepper
    • DC Motor
      • Description
      • Characteristics
      • Code examples
      • PID Position Control
      • Software API
        • MotorDc
        • MotorDcPidCtrl
    • Incremental Encoder
      • Description
      • Characteristics
      • Code examples
      • Software API
        • Encoder
    • RS232/485 Half Duplex
      • Description
      • Characteristics
      • Code examples
      • Software API
        • RS
    • CAN
      • Description
      • Code examples
      • Software API
        • CAN
        • CAN_Message_t
    • I2C (TTL 5V)
      • Description
      • Characteristics
      • Code examples
      • Software API
    • Ethernet 10BaseT/100BaseTX
      • Description
      • Code examples
    • Wifi 802.11 b/g/n
      • Description
      • Code examples
    • Bluetooth Low Energy
      • Description
      • Code examples
    • SD Card
      • Description
      • Code examples
    • Usb Host
      • Description
      • Code examples
    • Real Time Clock
      • Description
      • Code examples
      • Software API
        • RTClock

Mechanical

  • Mechanical Specifications
    • Description
    • Packages
      • BOI12
      • BOI13
      • BOI23
      • Rail

Projects

  • Projects
    • Demo Input/Output Kit
      • 1. Introduction
        • Who is this tutorial for?
        • Prerequisites
        • What will you learn?
      • 2. Discover your kit
        • Wiring diagrams
      • 3. Develop your own project
        • Introduction to OpenIndus IDE
        • Introduction to OpenIndus modules programming
        • Complete example project
    • Demo Input/Output Kit - Advanced BLE project
      • 1. Introduction
        • Who is this tutorial for?
        • Prerequisites
        • What will you learn?
      • 2. Get the project from GitHub
      • 3. Adding the NimBLE library to the project
        • Referencing the libraries in CMakeLists.txt
        • NimBLE-Arduino component wrapper
      • 4. Project structure
        • inouts.h - hardware abstraction interface
        • inouts.cpp - hardware abstraction layer
        • main.cpp - entry point
      • 5. BLE GATT server
        • Service and characteristics overview
        • ble.h - UUID definitions
        • blesetup() - GATT server initialization
        • Characteristic callbacks
        • bleloop() - sending notifications
        • Connection and security callbacks
      • 6. Adapting the project to your own needs
    • Demo Motors Kit
      • 1. Introduction
        • Who is this tutorial for?
        • Prerequisites
        • What will you learn?
      • 2. Discover your kit
        • Download and install the Android app
        • Check basic features of the kit
        • Wiring diagram
      • 3. Develop your own project
        • Introduction to OpenIndus IDE
        • Introduction to OpenIndus modules programming
        • Complete example project
    • Demo Motors Kit - Advanced BLE project
      • 1. Introduction
        • Who is this tutorial for?
        • Prerequisites
        • What will you learn?
      • 2. Get the project from GitHub
      • 3. Adding the NimBLE library to the project
        • Download the library with git submodules
        • Referencing the library in CMakeLists.txt
        • Root CMakeLists.txt - registering the submodule directory
        • NimBLE-Arduino component wrapper
      • 4. Project structure
        • system_definition.h - shared constants and types
        • commands.cpp - hardware abstraction layer
        • main.cpp - entry point
      • 5. BLE GATT server
        • Service and characteristics overview
        • bleSetup() - GATT server initialization
        • Characteristic callbacks
        • bleloop() - sending notifications
        • Connection and security callbacks
      • 6. Adapting the project to your own needs
    • Quick overview

FAQ

  • FAQ
    • My device is not detected by my computer
OpenIndus documentation
  • Modules list
  • Edit on GitHub

Modules list

  • OI-Core & OI-CoreLite
  • OI-Discrete
  • OI-Mixed
  • OI-AnalogLS
  • OI-Stepper
  • OI-RelayLP
  • OI-RelayHP
  • OI-Dc
Previous Next

© Copyright 2025, OpenIndus.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs version: latest
Versions
latest
v1.8.0
v2.0.0
v2.1.0