How to

📘 How-Tos: Step-by-Step Tutorials for OpenGate

Welcome to the How-Tos section—your hands-on guide to using OpenGate effectively. Whether you’re starting from scratch or building advanced workflows, these tutorials walk you through every step with clear instructions, screenshots, and best practices.

🏗️ Learning by Doing: A Real-World Scenario

To make this tutorial series more approachable and hands-on, we’ll follow a practical story that evolves across the different chapters. Instead of isolated examples, each tutorial will contribute to building a complete and functional solution using OpenGate. Our story follows an IT team tasked with monitoring a warehouse facility with an adjoining parking area. Their mission is to deploy sensors, collect data, and generate visualizations and alerts to ensure operational efficiency.

Throughout the series, we’ll walk step-by-step through their journey using the OpenGate IoT Platform to implement:

🅿️ Presence sensors for parking slots These will help detect occupancy status in real time for internal logistics or client access.
🌡️💧 Temperature and humidity sensors for the indoor areas Useful for monitoring environmental conditions in storage zones, employee workspaces, or sensitive equipment rooms.

Each one of the next chapters will build on the previous one — creating users, modeling data, provisioning entities, and building dashboards that reflect the real-world scenario of this IT team. By the end, we’ll have a fully functioning digital twin of their facility.

Let’s get started!

🔐 Pre-requisites

To follow these guides, make sure you have:

An active OpenGate account with access to a sandbox or production instance
Reviewed the Introduction, so you’re familiar with key concepts like Entities, DataStreams, Rules, Operations, and the platform architecture
Basic familiarity with REST APIs, JavaScript (for advanced tutorials), and Python (for Data Py integrations)

📚 How-Tos Overview

Each How-To guide is designed as a standalone tutorial but builds on the previous ones. You’ll find clear objectives, prerequisites, step-by-step instructions, and links to deeper documentation.

Accessing OpenGate & Navigating the Console:
Learn how to log in, explore the Web Console, and understand key sections.
Users and Roles:
Set up users, define roles, and assign permissions for secure and organized access control.
Data Modelling :
Create Entities and DataStreams to structure your IoT data model.
Entity Provisioning:
Onboard devices one by one or in bulk using wizards or Provision Functions.
Data Collection:
Send entities registered data via the Device Emulator and view data in entity panels.
Connector Functions:
Learn how to transform, enrich, and forward data to external systems.
Workspaces & Dashboards:
Build custom dashboards using widgets like LastValue, Entity Details, DataStream History, and Maps.
Operations:
Execute predefined tasks and operations on your entities from the catalog.
Easy Mode Rules:
Set up alerting and automation rules using the low-code GUI.
Analytics and Datalab:
Explore and work with your data using the OpenGate Data Lab superpowers with Jupter Notebooks and python.
Advanced tutorials
Extend your OpenGate skills with Dashboard tempaltes, Advanced rules configuration,and more.

🚧 This “Advanced tutorials” section is currently under develop 🚧

🤿 Deep diving

Here are a few key links to deepen your understanding:

REST APIs – Southbound & Northbound: Explore endpoints for device/data management and external system integration.
OpenGate Data Py: Pull data into Python notebooks—perfect for analytics and experimentation.
Analytics & AI Module: Learn how to leverage model training, inference pipelines, and integrated Jupyter notebooks.

✅ Next Step

Choose the first tutorial to begin your journey:

New to OpenGate? Start with “1. Accessing OpenGate & Navigating the Console”
Want to start building dashboards or automations? Jump to section 7 or 8

Let’s turn your IoT vision into reality—step by step with OpenGate!