Giter VIP home page Giter VIP logo

yasolr-oss's Introduction

YaS☀️lR (Yet another Solar Router)

Contributor Covenant GPLv3 license Download Doc Facebook Group

YaS☀️lR OSS YaS☀️lR OSS Build

Documentation

Please look at the website and manual for more information about how to flash.

👉 Website: https://yasolr.carbou.me/

Downloads

Please make sure to download the firmware matching your board from these locations:

  • latest (latest development version)

Firmware files are named as follow:

  • YaSolR-<VERSION>-oss--<BOARD>.bin: for the firmware used to update
  • YaSolR-<VERSION>-oss-<BOARD>.factory.bin: for the firmware used to flash for the first time or to do a factory reset

Where:

  • VERSION: YaS☀️lR version, or main for the latest development build
  • BOARD: the board name, from the list of Compatible ESP32 boards

Images ending with -debug are for development purpose or to troubleshoot issues: they are not optimized and output a lot of debug logs.

Developer guide

Project structure

  • .github: CI/CD workflows
  • data: Build components added to the firmware
  • include: Firmware include code
  • lib: Firmware libraries
  • pio: pio scripts
  • src: Firmware source code
  • test: Firmware tests
  • tools: Some random tools
  • partitions.csv: ESP32 custom partition table
  • platformio_override.ini.template (to copy to platformio_override.ini): PlatformIO configuration override
  • platformio.ini: PlatformIO configuration

Building the firmware

  1. Configure platformio_override.ini to your needs (you can copy the template file platformio_override.ini.template to platformio_override.ini for that)

  2. Build the file system and the firmware:

pio run -t build

Flashing

First time, flash the entire firmware which includes the partition table and all partitions:

esptool.py --port /dev/ttyUSB0 \
  --chip esp32 \
  --before default_reset \
  --after hard_reset \
  write_flash \
  --flash_mode dout \
  --flash_freq 40m \
  --flash_size detect \
  0x0 YaSolR-VERSION-MODEL-CHIP.factory.bin

Next time, just upload the partition you modify

pio run -t upload
pio run -t monitor

yasolr-oss's People

Contributors

mathieucarbou avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

yasolr-oss's Issues

Publish energy to MQTT

Hello,

The topic yasolr/grid/power is nice but is it possible to have a yasolr/grid/energy to publish the energy measure from JSY to Home Assistant Energy dashboard ?

My understanding is that energy counter from JSY will be more accurate than an outside estimation based on power x time .

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.