Introduction

Welcome to the UnderDeckLib Documentation

UnderDeckLib is a comprehensive Node.js library designed to facilitate interaction with the UnderDeck ecosystem. It offers functionalities for user management, WebSocket communication, interaction with REST APIs, and control of ESP32 devices via serial communication.

This documentation aims to provide a detailed guide on how to use UnderDeckLib in your projects, covering everything from installation to advanced use of its classes and methods.

Key Features

• Authentication and User Management: Log in, register, manage your profile, friends, and permissions.
• Real-time Communication: Use WebSockets for bidirectional communication with the UnderDeck server.
• ESP32 Device Interaction: Discover, connect, and send commands to ESP32 devices via serial port.
• Cloud Data Synchronization: Upload and download user data to the cloud.
• Customization: Manage themes, avatars, and profile styles.

Documentation Structure

This documentation is organized into the following sections:

• Introduction: Overview of the library and its capabilities.
• Installation: How to install and configure UnderDeckLib in your project.
• UnderDeck Class: Details about the main class, its methods, and events.
• Api Class: Information about interacting with the REST API.
• Esp32MultiManager Class: Guide for managing ESP32 devices.
• Data Models: Description of the data structures used in the library.
• Utilities: Helper functions for message processing and file upload.

Start by exploring the Installation section to set up your environment, then dive into the classes and methods to make the most of UnderDeckLib.