Quick Start Guide: General Lithium Platform for Developers

The General Lithium Platform empowers developers to create advanced battery monitoring and management solutions using edge devices, a robust SDK, and a centralized cloud platform. With the General Lithium Dev Kits and the GeneralLithiumSDK, you can streamline battery data collection, analysis, and visualization to deliver real-world impact for your projects.

In this guide, we'll walk you through the onboarding process, from setting up your dev kit to integrating it with the General Lithium Platform.

Why Build with the General Lithium Platform?

The General Lithium Platform provides a Battery Management System as a Service (BMSaaS) for monitoring and optimizing battery performance across diverse applications. Whether you're building solutions for enterprise IoT, defense, or edge AI, the platform offers:

• Seamless Integration: A lightweight, open-source SDK for rapid development with ESP32-based hardware.

• Scalability: Easily manage battery data from multiple devices using the cloud-backed General Lithium platform.

• Visualization: A user-friendly dashboard to monitor and configure devices.

• Flexibility: Free-tier access for individuals and feature-rich solutions for enterprise and government customers.

What You'll Need

Before getting started, make sure you have:

1. A General Lithium Dev Kit (ESP32-based hardware).

2. Access to the General Lithium Platform at https://platform.general-lithium.com.

3. The GeneralLithiumSDK, available via PlatformIO:
   GeneralLithiumSDK on PlatformIO Registry.

Step 1: Get Started on the General Lithium Platform

1. Log in or create an account at https://platform.general-lithium.com.

2. Navigate to the Teams page at https://platform.general-lithium.com/team.

3. Create a new team or use an existing one.

4. Copy your Organization UUID, which will be used to link your Dev Kit to your team.

Step 2: Set Up Your Development Environment

1. Install PlatformIO in your IDE (recommended: VSCode).

Import the GeneralLithiumSDK into your project. You can include the library via the lib_deps entry in your platformio.ini:

lib_deps =

jl-codes/GeneralLithiumSDK

2. Clone the General Lithium Dev Kit Example project:
   General Lithium Dev Kit Example on GitHub.

Step 3: Configure Your Dev Kit

1. Update the code in setup() to configure your Dev Kit:

#include <Arduino.h>

#include "GeneralLithiumSDK.h"

GeneralLithiumSDK lithiumSDK;

void setup() {

lithiumSDK.setOrganizationId("your-organization-uuid-here");

lithiumSDK.begin("YourWiFiSSID", "YourWiFiPassword");

}

void loop() {

lithiumSDK.update(10000); // Update data every 10 seconds

}

2. Replace your-organization-uuid-here with the UUID copied from your team page.

3. Set your Wi-Fi credentials for SSID and password.

Step 4: Deploy Your Dev Kit

1. Flash the firmware to your Dev Kit using PlatformIO. Ensure it's connected to your machine.

2. Monitor the serial output to confirm the device connects to your Wi-Fi and the platform.

3. Navigate to the Dashboard at https://platform.general-lithium.com/dashboard to view your connected devices and real-time data.

Explore the Platform

The General Lithium Platform offers a centralized view of your battery systems:

• Dashboard: View connected batteries, live data, and health metrics.

• Teams Page: Manage organizations and users associated with your devices.

• Advanced Features: For enterprise customers, unlock automated alerts, predictive analytics, and API integrations.

Ready to Build?

The General Lithium Platform is the perfect launchpad for battery-powered solutions. Whether you're prototyping a new IoT device or managing an industrial battery fleet, the combination of our Dev Kits and SDK makes development intuitive and scalable.

Join Our Community

We’d love to see what you’re building! Share your projects, ask questions, or explore collaboration opportunities by visiting our GitHub repository or reaching out via https://general-lithium.com

.Let’s power the future—together.

This guide is designed to get you up and running quickly. If you have questions or run into issues, consult our documentation or reach out to our support team.