openSCUPS documentation

Introduction

  • What is OpenSCUPS?
  • Project Motivation and Goals
  • Key Features and Capabilities
  • License Information

Safety Precautions

  • Working with High Voltage and Current
  • Battery Safety
  • General Workshop Safety

Hardware

  • System Overview
    • Block Diagram
    • Component Interaction
  • Required Components
    • Off-the-shelf Components (12V batteries, chargers, power supplies)
    • Custom Electronics (ESP8266 based control board)
  • PCB (Printed Circuit Board)
    • PCB Design Files and Schematics
    • Understanding the Schematics
    • Ordering/Making the PCB
  • Enclosure and Physical Assembly (Kastinbouw)
    • Recommended Enclosure (Steel for fire safety)
    • Step-by-Step Assembly Guide
    • Wiring Guide
  • Temperature Sensor Integration (External or Integrated)

Software/Firmware

  • ESP8266 Microcontroller
  • Firmware Source Code
    • Obtaining the Code (Link to GitHub)
    • Development Environment Setup
    • Compiling and Uploading Firmware
  • Program Logic and Flow Diagrams
    • Main Control Loop
    • Solar Charging Algorithm
    • UPS Switching Logic
    • MQTT Communication Protocol
  • Over-the-Air (OTA) Firmware Updates

Configuration and Setup

  • Initial Hardware Checks
  • Software Configuration
    • Wi-Fi Setup
    • MQTT Broker Configuration
    • Custom Parameters
  • Connecting to Home Automation Systems

Usage and Operation

  • Powering On and Off
  • Monitoring the System (e.g., via MQTT)
  • Understanding System States and Indicators

Troubleshooting

  • Common Issues and Solutions
  • Error Codes/Messages
  • How to Get Help (Community/Forum, Link to GitHub Issues)

Future Development and Improvements

  • Planned Features (e.g., ESP32 upgrade, integrated temperature sensor)
  • Known Limitations

Contributing to the Project

  • How to Contribute (Code, Documentation, Testing)
  • Reporting Bugs
  • Suggesting Enhancements

FAQ (Frequently Asked Questions)

Glossary of Terms