Developer Guide

Welcome to the Voltimax Platform Developer Guide. This section is designed for core contributors and developers working on the platform codebase.

Getting Started

New to the codebase? Start here:

• Development Setup - Set up your local development environment
• Documentation Guide - Learn how to write and maintain documentation
• Style Guide - Writing standards and conventions

Developer Tools

iot-tools CLI

The iot-tools CLI is your primary development tool for:

• Generating C# code from schema definitions
• Creating documentation from OCPP, SunSpec, and Metrics schemas
• Validating schema files
• Publishing the Edge Gateway

Schema Generation

The platform uses schema-driven code generation:

• Schema Generation Overview - How schema-driven development works
• Metrics Generator - Generate metric types, catalogs, and Elasticsearch mappings
• Asset Generator - Generate Modbus device base classes from YAML definitions

Docker

• Docker Compose - Local development configurations for running gateway containers

Infrastructure

• Migration Service - Database migrations, Keycloak setup, and data seeding

Reference Documentation

Quick access to technical references:

• Data Model - Metric keys, units, asset types, and profiles
• Metrics - Metrics schema and telemetry formats
• OCPP 2.1 - Open Charge Point Protocol reference
• SunSpec Models - SunSpec model specifications

Architecture Overview

The Voltimax Platform consists of these key components:

• Edge Gateway - Runs locally on customer sites, manages device connections
• Cloud Platform - Centralized API and data management services
• Frontend - Web-based management interface
• Data Pipeline - Metrics processing and storage (Elasticsearch)

For detailed architecture information, see the Architecture Guide.

Need Help?

If you're working on the platform and need help:

• Check the existing documentation
• Review open issues on GitHub
• Reach out to the core development team