Introduction
Welcome to the documentation for ParticleSetup! In this guide, we will walk you through the process of setting up and using ParticleSetup in your projects.
Table of Contents
Installation
To install ParticleSetup, follow these steps:
- Download the latest version of the library from the ParticleSetup GitHub repository.
- Extract the downloaded file.
- Copy the ParticleSetup folder to your project’s libraries folder.
- Add `#include
` to the top of your project file.
Usage
To use ParticleSetup in your project, you need to follow these steps:
- Create an instance of the ParticleSetup class.
- Call the `begin()` function to initialize the library.
- Set up callback functions for different events such as device provisioning, Wi-Fi configuration, etc.
- Call the `loop()` function in your main loop to handle any necessary operations.
Configuration
ParticleSetup provides various configuration options for customization. Here are some important options:
- particle_cloud_url: The URL of the Particle Cloud server.
- device_name: The name of the device.
- wifi_customization: Option to enable/disable Wi-Fi customization during the setup process.
- callback_timeout: The maximum time for a callback function to complete before timing out.
Advanced Features
ParticleSetup offers advanced features to enhance your setup process:
- Customizing the setup UI with your own branding.
- Defining your own callback functions for various setup events.
- Handling edge cases like timeouts, failures, etc.
Examples
Here are a few examples to help you get started with ParticleSetup:
- Example 1: Simple device setup using default configuration
- Example 2: Customizing the setup UI
- Example 3: Handling Wi-Fi configuration errors
Support
If you encounter any issues or have any questions, please reach out to our support team at support@particlesetup.com.
Additionally, you can visit our GitHub repository for known issues or to submit new ones.