docs

Getting Started

Welcome to the Getting Started guide for the Telemetry On Tap digital dispense system.
This documentation will help you understand the system’s architecture, components, and how they work together to deliver precise, configurable beverage dispensing. Whether you’re developing a new machine, expanding functionality, or troubleshooting an existing setup, this guide serves as the starting point.


📚 Introduction

The Introduction section covers the fundamental concepts and terminology used throughout this documentation.
It’s highly recommended to review this first before diving into hardware, software, or troubleshooting topics.


🔩 Hardware

The Hardware section provides an overview of the physical components that make up the system and how they integrate. It includes device installation, wiring considerations, and tips for proper setup and maintenance.


💻 Software

The Software section explains the software layers that drive the system, from the operating system and firmware to the user interface and API.
This section will help you understand how the software interacts with hardware components and how to configure it for your application.


🛠️ Troubleshooting

The Troubleshooting section offers diagnostic tools, recommended procedures, and debugging methods for common issues.
Use this section to diagnose hardware, firmware, and communication problems and get your system back online quickly.


If you’re new to the system, we suggest going through the documentation in the following order:

  1. Introduction → Core Concepts – Understand key terms and ideas.
  2. Introduction → Benefits – Learn what the system enables and why.
  3. Introduction → Scenarios – Explore how the system operates in real use cases.
  4. Hardware – Set up and verify physical components.
  5. Software – Configure, calibrate, and control the system.
  6. Troubleshooting – Use as reference when issues arise.

Next Steps

👉 Begin with the Introduction to get familiar with the system’s foundational terminology and ideas.