About qToggle

qToggle is a way of interconnecting sensors, actuators and other data sources. qToggle works by leveraging the power of a flexible API, which lays the groundwork of a simple, common communication scheme.

qToggle attempts to impose a standard that allows managing, provisioning and talking to devices. Rather than reinventing the wheel, qToggle makes use of existing, widely used, technologies, such as RESTful APIs on top of HTTP, passing over data encoded as JSON.

There currently are two opensource implementations of the qToggle API:

• qToggleServer, offering a backend written in Python and a frontend in the form of a progressive web app
• espQToggle, supplied as firmware for the ESP8266/8285-based devices

In addition to these, qToggleOS is a ready-to-use lightweight OS image for the Raspberry Pi devices, which embeds a preinstalled qToggleServer, along with some other nice-to-have features.

Getting Started

Choose Your Devices

The first thing you’ll want to do is order some devices from the supported devices based on the ESP8266 chip.

You may also need a Raspberry Pi board (variants 3 or 4 are recommended), with accessories. The Pi board may have three roles in a qToggle setup:

• it could act as a qToggle device, when equipped with peripherals such as sensors or relay boards
• it could act as a hub (master) for other qToggle devices
• it could help installing the ESP firmware on some devices, when running Tuya Convert OS

Documentation

Most of the documentation can be found on GitHub, on the wiki pages of each project. Here are a few pages to get you up to speed with qToggle:

• The basic notions page will get you better acquainted with qToggle terms, components and scenarios.
• The FAQ will hopefully answer some of the questions you may have.
• The qToggleServer’s Getting Started page will help you set up your hub.
• Finally, check out the espQToggle Wiki if you want to use an ESP-based device with qToggle.