├── requirements.txt ├── scripts ├── docker-run.sh ├── docker-build.sh ├── docker-publish.sh └── docker-build-all.sh ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md └── workflows │ └── image.yml ├── docker └── docker-compose.yml ├── Dockerfile ├── config.sample.json ├── k8s └── Solarman-Deployment.yaml ├── .gitignore ├── mqtt.py ├── CODE_OF_CONDUCT.md ├── README.md ├── solarman.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | paho_mqtt==1.5.1 2 | -------------------------------------------------------------------------------- /scripts/docker-run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | docker run hareeshmu/solarman:latest 3 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [hareeshmu] 4 | -------------------------------------------------------------------------------- /scripts/docker-build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | docker build --platform linux/amd64 --tag hareeshmu/solarman:latest ../ 3 | -------------------------------------------------------------------------------- /scripts/docker-publish.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | docker buildx build --platform linux/ppc64le,linux/s390x,linux/386,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/amd64 --tag hareeshmu/solarman:latest --push ../ 3 | -------------------------------------------------------------------------------- /scripts/docker-build-all.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | docker buildx build --platform linux/ppc64le,linux/s390x,linux/386,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/amd64 --tag hareeshmu/solarman:latest ../ 3 | # TODO: Support linux/riscv64 4 | -------------------------------------------------------------------------------- /docker/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | services: 3 | solarman: 4 | image: hareeshmu/solarman:latest 5 | container_name: solarman 6 | environment: 7 | - PUID=1000 8 | - PGID=1000 9 | volumes: 10 | - /YOUR/PATH/HERE/config.json:/config.json 11 | restart: unless-stopped 12 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # ---- Base ---- 2 | FROM python:alpine AS base 3 | 4 | # 5 | # ---- Dependencies ---- 6 | FROM base AS dependencies 7 | # install dependencies 8 | COPY requirements.txt . 9 | RUN pip install -r requirements.txt 10 | 11 | # 12 | # ---- Release ---- 13 | FROM dependencies AS release 14 | # copy project source file(s) 15 | WORKDIR / 16 | COPY solarman.py . 17 | COPY mqtt.py . 18 | CMD ["python", "-u", "/solarman.py", "--repeat"] -------------------------------------------------------------------------------- /config.sample.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Solarman", 3 | "url": "api.solarmanpv.com", 4 | "appid": "1234567890", 5 | "secret": "234abcdefg123456", 6 | "username": "someuser@example.com", 7 | "password": "password", 8 | "orgId": "", 9 | "stationId": 1234567, 10 | "inverterId": "SA12345MB12345", 11 | "loggerId": 789543245, 12 | "interval": 300, 13 | "debug": true, 14 | "mqtt": { 15 | "broker": "10.10.10.10", 16 | "port": 1883, 17 | "topic": "solarmanpv", 18 | "username": "mqtt_user", 19 | "password": "mqtt_password" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: 'hareeshmu' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /k8s/Solarman-Deployment.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: solarman 5 | spec: 6 | selector: 7 | matchLabels: 8 | app: solarman 9 | template: 10 | metadata: 11 | labels: 12 | app: solarman 13 | spec: 14 | containers: 15 | - name: solarman 16 | image: hareeshmu/solarman:latest 17 | resources: 18 | limits: 19 | memory: "32Mi" 20 | cpu: "50m" 21 | env: 22 | - name: CONFIG_PATH 23 | value: "/etc/solarman/" 24 | volumeMounts: 25 | - mountPath: "/etc/solarman" 26 | name: config-solarman 27 | readOnly: true 28 | volumes: 29 | - name: config-solarman 30 | secret: 31 | secretName: config-solarman -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: 'hareeshmu' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. Arch Linux] 28 | - Browser [e.g. Chrome, Safari] 29 | - Version [e.g. 60] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone X] 33 | - OS: [e.g. iOS 14.0] 34 | - Browser [e.g. stock browser, Safari] 35 | - Version [e.g. 60] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Private API keys for updating IPv4 & IPv6 addresses on Cloudflare 2 | config.json 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | pip-wheel-metadata/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Jupyter Notebook 44 | .ipynb_checkpoints 45 | 46 | # IPython 47 | profile_default/ 48 | ipython_config.py 49 | 50 | # pyenv 51 | .python-version 52 | 53 | # Environments 54 | .env 55 | .venv 56 | env/ 57 | venv/ 58 | ENV/ 59 | env.bak/ 60 | venv.bak/ -------------------------------------------------------------------------------- /.github/workflows/image.yml: -------------------------------------------------------------------------------- 1 | name: Build solarman Docker image (multi-arch) 2 | # update docker hub details 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout code 14 | uses: actions/checkout@v2 15 | # https://github.com/docker/setup-qemu-action 16 | - name: Set up QEMU 17 | uses: docker/setup-qemu-action@v1 18 | # https://github.com/docker/setup-buildx-action 19 | - name: Setting up Docker Buildx 20 | uses: docker/setup-buildx-action@v1 21 | - name: Login to DockerHub 22 | if: github.event_name != 'pull_request' 23 | uses: docker/login-action@v1 24 | with: 25 | username: ${{ secrets.DOCKER_USERNAME }} 26 | password: ${{ secrets.DOCKER_PASSWORD }} 27 | 28 | - name: Extract branch name 29 | shell: bash 30 | run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})" 31 | id: extract_branch 32 | - name: Docker meta 33 | id: meta 34 | uses: docker/metadata-action@v3 35 | with: 36 | images: hareeshmu/solarman 37 | sep-tags: ',' 38 | flavor: | 39 | latest=false 40 | tags: | 41 | type=raw,enable=${{ steps.extract_branch.outputs.branch == 'main' }},value=latest 42 | type=schedule 43 | type=ref,event=pr 44 | 45 | - name: Build and publish 46 | uses: docker/build-push-action@v2 47 | with: 48 | context: . 49 | push: ${{ github.event_name != 'pull_request' }} 50 | tags: ${{ steps.meta.outputs.tags }} 51 | platforms: linux/ppc64le,linux/s390x,linux/386,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/amd64 52 | labels: | 53 | org.opencontainers.image.source=${{ github.event.repository.html_url }} 54 | org.opencontainers.image.created=${{ steps.meta.outputs.created }} 55 | org.opencontainers.image.revision=${{ github.sha }} 56 | -------------------------------------------------------------------------------- /mqtt.py: -------------------------------------------------------------------------------- 1 | """ 2 | MQTT connect and publish 3 | """ 4 | 5 | import logging 6 | import random 7 | import time 8 | from paho.mqtt import client as mqtt_client 9 | 10 | def time_stamp(): 11 | """ 12 | Return current time in YYYY-MM-DD hh:mm:ss 13 | :return: 14 | """ 15 | return time.strftime("%Y-%m-%d %H:%M:%S") 16 | 17 | def connect_mqtt(broker, port, username, password): 18 | """ 19 | Create an MQTT connection 20 | :param broker: MQTT broker 21 | :param port: MQTT broker port 22 | :param username: MQTT username 23 | :param password: MQTT password 24 | :return: 25 | """ 26 | print(f"{time_stamp()}: 🔥 Connecting mqtt: {broker} on port: {port} as user: {username}") 27 | client_id = f'solarman-{random.randint(0, 1000)}' 28 | client = mqtt_client.Client(client_id) 29 | client.username_pw_set(username, password) 30 | client.connect(broker, port) 31 | return client 32 | 33 | 34 | def publish(client, topic, msg, debug): 35 | """ 36 | Publish a message on a MQTT topic 37 | :param client: Connect parameters 38 | :param topic: MQTT topic 39 | :param msg: Message payload 40 | :return: 41 | """ 42 | if debug: 43 | print(f"{time_stamp()}: 🔥 Publishing message to mqtt: {msg} on topic: {topic}") 44 | result = client.publish(topic, msg) 45 | status = result[0] 46 | if status == 0: 47 | print(f"{time_stamp()}: 🔥 MQTT message published to topic: {topic}") 48 | else: 49 | print(f"{time_stamp()}: 😡 Failed to send mqtt message to topic: {topic}") 50 | 51 | 52 | def message(config, topic, msg, debug): 53 | """ 54 | MQTT Connect and send 55 | :param config: Broker configuration 56 | :param topic: MQTT topic 57 | :param msg: Message payload 58 | """ 59 | try: 60 | client = connect_mqtt(config["broker"], config["port"], config["username"], config["password"]) 61 | publish(client, topic, msg, debug) 62 | except Exception as error: # pylint: disable=broad-except 63 | print(f"{time_stamp()}: 😡 Unable to connect mqtt: {str(error)}") 64 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | . 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ⚡ solarman 2 | 3 | ![Solarman Workflow](https://github.com/hareeshmu/solarman/actions/workflows/image.yml/badge.svg) [![solarman docker image size](https://img.shields.io/docker/image-size/hareeshmu/solarman?style=flat-square)](https://hub.docker.com/r/hareeshmu/solarman "solarman docker image size") [![Total DockerHub pulls](https://img.shields.io/docker/pulls/hareeshmu/solarman?style=flat-square)](https://hub.docker.com/r/hareeshmu/solarman "Total DockerHub pulls") 4 | 5 | Script to retrieve current Solar PV data from the Solarman API, and send Power (W) and Energy (kWh) metrics to a MQTT broker, for further use in home automation. Several PV vendors use the Solarman Smart platform for statistics, like sofar inverter with logger. 6 | 7 | ```lang=bash 8 | usage: solarman.py [--repeat] 9 | 10 | Collect data from Solarman API 11 | 12 | optional arguments: 13 | --repeat Repeat at every interval defined in the config 14 | ``` 15 | 16 | ## Usage 17 | 18 | You can run this script as a Docker container or in Python 3. Either way a configuration file is required. See the sample `config.sample.json` file in this repository for reference. Also, a Solarman API appid and secret is required, which can be requested via . 19 | 20 | ### Using Docker 21 | 22 | Supported platforms: 23 | 24 | * linux/amd64 25 | * linux/386 26 | * linux/arm/v7 27 | * linux/arm/v6 28 | * linux/arm64 29 | 30 | Docker example to run this script every 5 minutes and providing a config file: 31 | 32 | ```lang=bash 33 | cd /opt 34 | git clone https://github.com/hareeshmu/solarman 35 | cd solarman 36 | mv config.sample.json config.json # setup your config 37 | sudo docker run --name solarman -d --restart unless-stopped -v /YOUR/PATH/HERE/config.json:/config.json hareeshmu/solarman:latest 38 | ``` 39 | 40 | ### Using docker-compose 41 | 42 | This `docker-compose.yml` example can be used with docker-compose or podman-compose 43 | 44 | ```lang=yaml 45 | version: "3.7" 46 | services: 47 | solarman: 48 | image: hareeshmu/solarman:latest 49 | container_name: solarman 50 | environment: 51 | - PUID=1000 52 | - PGID=1000 53 | volumes: 54 | - /YOUR/PATH/HERE/config.json:/config.json 55 | restart: unless-stopped 56 | ``` 57 | 58 | ### Using Python 59 | 60 | Run `pip install -r requirements.txt` and start `python3 solarman.py`. 61 | 62 | Run `pip install -r requirements.txt` and start `python3 solarman.py --repeat`. 63 | 64 | ## MQTT topics 65 | 66 | ### Station (Plant) 67 | 68 | ```lang=bash 69 | solarmanpv/station/batteryPower 70 | solarmanpv/station/batterySoc 71 | solarmanpv/station/chargePower 72 | solarmanpv/station/dischargePower 73 | solarmanpv/station/generationPower 74 | solarmanpv/station/gridPower 75 | solarmanpv/station/irradiateIntensity 76 | solarmanpv/station/lastUpdateTime 77 | solarmanpv/station/purchasePower 78 | solarmanpv/station/usePower 79 | solarmanpv/station/wirePower 80 | ``` 81 | 82 | ### Inverter 83 | 84 | ```lang=bash 85 | solarmanpv/inverter/deviceId 86 | solarmanpv/inverter/deviceSn 87 | solarmanpv/inverter/deviceState 88 | solarmanpv/inverter/deviceType 89 | 90 | solarmanpv/inverter/attributes # contains all inverter datalist entries. 91 | ``` 92 | 93 | #### Inverter Attributes 94 | 95 | ```lang=bash 96 | SN: XXXXXXXXXX 97 | Device_Type: 4 98 | Production_Compliance_Type: 0 99 | Rated_Power: 300.00 100 | Year: 48 101 | Month: 0 102 | Day: 0 103 | Hour: 0 104 | Minute: 0 105 | Seconds: 0 106 | Communication_Protocol_Version: V0.2.0.1 107 | Control_Board_Firmware_Version: V0.1.1.2 108 | Communication_Board_Firmware_Version: V0.2.0.7 109 | DC_Voltage_PV1: 0.00 110 | DC_Voltage_PV2: 0.00 111 | DC_Voltage_PV3: 0.00 112 | DC_Voltage_PV4: 0.00 113 | DC_Current_PV1: 0.00 114 | DC_Current_PV2: 0.00 115 | DC_Current_PV3: 0.00 116 | DC_Current_PV4: 0.00 117 | DC_Power_PV1: 0.00 118 | DC_Power_PV2: 0.00 119 | DC_Power_PV3: 0.00 120 | DC_Power_PV4: 0.00 121 | AC_Voltage_1: 0.00 122 | AC_Current_1: 0.00 123 | Total_AC_Output_Power(Active): 0 124 | AC_Output_Frequency_1: 0.00 125 | Total_Production(Active): 2.50 126 | Total_Production_1: 2.50 127 | Total_Production_2: 0.00 128 | Total_Production_3: 0.00 129 | Total_Production_4: 0.00 130 | Daily_Production(Active): 0.70 131 | Daily_Production_1: 0.70 132 | Daily_Production_2: 0.00 133 | Daily_Production_3: 0.00 134 | Daily_Production_4: 0.00 135 | AC_Radiator_Temp: -10.00 136 | Micro_Inverter_Port_1: XXXXXXXXXX-1 137 | Micro_Inverter_Port_2: XXXXXXXXXX-2 138 | Micro_Inverter_Port_3: XXXXXXXXXX-3 139 | Micro_Inverter_Port_4: XXXXXXXXXX-4 140 | Number_Of_MPPT_Paths: 1 141 | Number_Of_Phases: 1 142 | Running_Status: 4 143 | Overfrequency_And_Load_Reduction_Starting_Point: 50.20 144 | Islanding Protection Enabled: Enable 145 | Overfrequency_And_Load_Reduction_Percentage: 44 146 | GFDI Enabled: Disable 147 | Grid-connected Standard: 0 148 | Grid Voltage_Upper_Limit: 275.00 149 | Grid Voltage_Lower_Limit: 180.00 150 | Grid Frequency_Upper_Limit: 52.00 151 | Grid Frequency_Lower_Limit: 47.50 152 | Start-up Self-checking Time: 60 153 | ``` 154 | 155 | ### Logger (Collector) 156 | 157 | ```lang=bash 158 | solarmanpv/logger/deviceId 159 | solarmanpv/logger/deviceSn 160 | solarmanpv/logger/deviceState 161 | solarmanpv/logger/deviceType 162 | 163 | solarmanpv/logger/attributes # contains all logger datalist entries 164 | ``` 165 | 166 | #### Logger Attributes 167 | 168 | ```lang=bash 169 | Embedded_Device_SN: XXXXXXXXXX 170 | Module_Version_No: MW3_15_5406_1.35 171 | Extended_System_Version: V1.1.00.07 172 | Total_running_time: 1 173 | Offset_time: 1634486607 174 | Data_Uploading_Period: 5 175 | Data_Acquisition_Period: 60 176 | Max._No._of_Connected_Devices: 1 177 | Signal_Strength: 100 178 | Heart_Rate: 120 179 | IV_Curve_Supported: 1 180 | Batch_Command_Supported: 1 181 | Support_Reporting_Upgrading_Progress: 0 182 | AT+UPGRADE_Command_Supported: 255 183 | Method_Of_Protocol_Upgrade: 255 184 | ``` 185 | 186 | ## Home Assistant 187 | 188 | ```lang=bash 189 | sensor: 190 | - platform: mqtt 191 | name: "solarmanpv_station_generationPower" 192 | state_topic: "solarmanpv/station/generationPower" 193 | unit_of_measurement: "W" 194 | state_class: measurement 195 | ``` 196 | 197 | Repeat for every station topic needed. 198 | 199 | ```lang=bash 200 | sensor: 201 | - platform: mqtt 202 | name: "solarmanpv_inverter" 203 | state_topic: "solarmanpv/inverter/deviceState" 204 | json_attributes_topic: "solarmanpv/inverter/attributes" 205 | 206 | - platform: mqtt 207 | name: "solarmanpv_logger" 208 | state_topic: "solarmanpv/logger/deviceState" 209 | json_attributes_topic: "solarmanpv/logger/attributes" 210 | 211 | - platform: template 212 | sensors: 213 | solarmanpv_inverter_device_state: 214 | entity_id: sensor.solarmanpv_inverter 215 | value_template: >- 216 | {% set mapper = { 217 | '1' : 'Online', 218 | '2' : 'Failure', 219 | '3' : 'Offline'} %} 220 | {% set state = states.sensor.solarmanpv_inverter.state %} 221 | {{ mapper[state] if state in mapper else 'Unknown' }} 222 | 223 | - platform: template 224 | sensors: 225 | solarmanpv_logger_device_state: 226 | entity_id: sensor.solarmanpv_logger 227 | value_template: >- 228 | {% set mapper = { 229 | '1' : 'Online', 230 | '2' : 'Failure', 231 | '3' : 'Offline'} %} 232 | {% set state = states.sensor.solarmanpv_logger.state %} 233 | {{ mapper[state] if state in mapper else 'Unknown' }} 234 | 235 | ``` 236 | 237 | ### Templates 238 | 239 | ```lang=bash 240 | template: 241 | - sensor: 242 | - name: solarmanpv_inverter_dc_voltage_pv1 243 | unit_of_measurement: 'V' 244 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'DC_Voltage_PV1') }}" 245 | state_class: measurement 246 | - sensor: 247 | - name: solarmanpv_inverter_dc_current_pv1 248 | unit_of_measurement: 'A' 249 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'DC_Current_PV1') }}" 250 | state_class: measurement 251 | 252 | - sensor: 253 | - name: solarmanpv_inverter_dc_power_pv1 254 | unit_of_measurement: 'W' 255 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'DC_Power_PV1') }}" 256 | state_class: measurement 257 | 258 | - sensor: 259 | - name: solarmanpv_inverter_dc_power_pv1 260 | unit_of_measurement: 'W' 261 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'DC_Power_PV1') }}" 262 | state_class: measurement 263 | 264 | - sensor: 265 | - name: solarmanpv_inverter_total_production_1 266 | unit_of_measurement: 'kWh' 267 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'Total_Production_1') }}" 268 | state_class: total_increasing 269 | 270 | - sensor: 271 | - name: solarmanpv_inverter_daily_production_1 272 | unit_of_measurement: 'kWh' 273 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'Daily_Production_1') }}" 274 | state_class: total_increasing 275 | 276 | - sensor: 277 | - name: solarmanpv_inverter_ac_radiator_temp 278 | unit_of_measurement: '°C' 279 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'AC_Radiator_Temp') }}" 280 | state_class: measurement 281 | 282 | - sensor: 283 | - name: solarmanpv_inverter_ac_voltage_1 284 | unit_of_measurement: 'V' 285 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'AC_Voltage_1') }}" 286 | state_class: measurement 287 | 288 | - sensor: 289 | - name: solarmanpv_inverter_ac_current_1 290 | unit_of_measurement: 'A' 291 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'AC_Current_1') }}" 292 | state_class: measurement 293 | 294 | - sensor: 295 | - name: solarmanpv_inverter_ac_output_frequency_1 296 | unit_of_measurement: 'Hz' 297 | state: "{{ state_attr('sensor.solarmanpv_inverter', 'AC_Output_Frequency_1') }}" 298 | state_class: measurement 299 | 300 | ``` 301 | -------------------------------------------------------------------------------- /solarman.py: -------------------------------------------------------------------------------- 1 | """ 2 | Collect PV data from the Solarman API and send Power and Energy data (W+kWh) to MQTT 3 | """ 4 | 5 | __version__ = "1.0.0" 6 | 7 | import http.client 8 | import json 9 | import hashlib 10 | import os 11 | import sys 12 | import time 13 | import signal 14 | import mqtt 15 | 16 | CONFIG_PATH = os.environ.get('CONFIG_PATH', os.getcwd() + "/") 17 | 18 | def signal_handler(signal, frame): 19 | print(f"{time_stamp()}: 🛑 [SIGINT] Exiting...") 20 | time.sleep(1) 21 | sys.exit(0) 22 | 23 | signal.signal(signal.SIGINT, signal_handler) 24 | 25 | def load_config(file): 26 | """ 27 | Load configuration 28 | :return: 29 | """ 30 | with open(file, "r", encoding="utf-8") as config_file: 31 | config = json.load(config_file) 32 | return config 33 | 34 | 35 | def time_stamp(): 36 | """ 37 | Return current time in YYYY-MM-DD hh:mm:ss 38 | :return: 39 | """ 40 | return time.strftime("%Y-%m-%d %H:%M:%S") 41 | 42 | 43 | def get_token(url, appid, secret, username, password, orgId=None): 44 | """ 45 | Get a token from the API 46 | :return: access_token 47 | """ 48 | print(f"{time_stamp()}: 🕵️ Getting token from: {url}") 49 | 50 | try: 51 | passhash = hashlib.sha256(password.encode()) 52 | passhash = passhash.hexdigest() 53 | conn = http.client.HTTPSConnection(url) 54 | if orgId: 55 | print(f"{time_stamp()}: 🕵️ Using organization ID: {orgId}") 56 | payload = json.dumps({"appSecret": secret, "email": username, "password": passhash, "orgId": orgId}) 57 | else: 58 | payload = json.dumps({"appSecret": secret, "email": username, "password": passhash}) 59 | headers = {"Content-Type": "application/json"} 60 | url = f"//account/v1.0/token?appId={appid}&language=en" 61 | conn.request("POST", url, payload, headers) 62 | res = conn.getresponse() 63 | data = json.loads(res.read()) 64 | print(f"{time_stamp()}: 🔥 Token received successfully") 65 | return data["access_token"] 66 | except Exception as error: # pylint: disable=broad-except 67 | print(f"{time_stamp()}: 😡 Unable to fetch token: {str(error)}") 68 | return None 69 | 70 | 71 | def get_station_realtime(url, stationid, token): 72 | """ 73 | Return station realtime data 74 | :return: realtime data 75 | """ 76 | print(f"{time_stamp()}: 🕵️ Fetching station realtime data for station: {stationid}") 77 | try: 78 | conn = http.client.HTTPSConnection(url) 79 | payload = json.dumps({"stationId": stationid}) 80 | headers = {"Content-Type": "application/json", "Authorization": "bearer " + token} 81 | conn.request("POST", "//station/v1.0/realTime?language=en", payload, headers) 82 | res = conn.getresponse() 83 | data = json.loads(res.read()) 84 | print(f"{time_stamp()}: 🔥 Station realtime data received successfully") 85 | return data 86 | except Exception as error: # pylint: disable=broad-except 87 | print(f"{time_stamp()}: 😡 Unable to fetch station realtime data: {str(error)}") 88 | return None 89 | 90 | 91 | def get_device_current_data(url, device_sn, token): 92 | """ 93 | Return device current data 94 | :return: current data 95 | """ 96 | print(f"{time_stamp()}: 🕵️ Fetching data for device: {device_sn}") 97 | try: 98 | conn = http.client.HTTPSConnection(url) 99 | payload = json.dumps({"deviceSn": device_sn}) 100 | headers = {"Content-Type": "application/json", "Authorization": "bearer " + token} 101 | conn.request("POST", "//device/v1.0/currentData?language=en", payload, headers) 102 | res = conn.getresponse() 103 | data = json.loads(res.read()) 104 | print(f"{time_stamp()}: 🔥 Device data received successfully") 105 | return data 106 | except Exception as error: # pylint: disable=broad-except 107 | print(f"{time_stamp()}: 😡 Unable to fetch device current data: {str(error)}") 108 | return None 109 | 110 | def restruct_and_separate_current_data(data, device): 111 | """ 112 | Return restructured and separated device current data 113 | Original data is removed 114 | :return: new current data 115 | """ 116 | print(f"{time_stamp()}: 🕵️ Processing data... {device}") 117 | 118 | if data is None: 119 | print(f"{time_stamp()}: 😡 Error: Unable to process data for device: {device}, data is empty") 120 | 121 | try: 122 | new_data_list = {} 123 | if data["dataList"]: 124 | data_list = data["dataList"] 125 | for i in data_list: 126 | del i["key"] 127 | name = i["name"] 128 | name = name.replace(" ", "_") 129 | del i["name"] 130 | new_data_list[name] = i["value"] 131 | del data["dataList"] 132 | return new_data_list 133 | except Exception as error: # pylint: disable=broad-except 134 | print(f"{time_stamp()}: 😡 Error while processing data: {str(error)}") 135 | return None 136 | 137 | def run(config): 138 | """ 139 | Output current watts and kilowatts 140 | :return: 141 | """ 142 | 143 | token = get_token(config["url"], config["appid"], config["secret"], config["username"], config["password"], config["orgId"]) 144 | 145 | if token is None: 146 | print(f"{time_stamp()}: 😡 Unable to get token") 147 | return 148 | 149 | if config["debug"]: 150 | print(f"{time_stamp()}: 🕵️ Token: {token}") 151 | 152 | station_data = get_station_realtime(config["url"], config["stationId"], token) 153 | inverter_data = get_device_current_data(config["url"], config["inverterId"], token) 154 | logger_data = get_device_current_data(config["url"], config["loggerId"], token) 155 | 156 | inverter_data_list = restruct_and_separate_current_data(inverter_data, "Inverter") 157 | logger_data_list = restruct_and_separate_current_data(logger_data, "Logger") 158 | 159 | if config["debug"]: 160 | print(f"{time_stamp()}: ⚡ Station data:") 161 | print(json.dumps(station_data, indent=4, sort_keys=True)) 162 | 163 | print(f"{time_stamp()}: ⚡ Inverter data:") 164 | print(json.dumps(inverter_data, indent=4, sort_keys=True)) 165 | 166 | print(f"{time_stamp()}: ⚡ Inverter Data List:") 167 | print(json.dumps(inverter_data_list, indent=4, sort_keys=True)) 168 | 169 | print(f"{time_stamp()}: ⚡ Logger data:") 170 | print(json.dumps(logger_data, indent=4, sort_keys=True)) 171 | 172 | print(f"{time_stamp()}: ⚡ Logger Data List:") 173 | print(json.dumps(logger_data_list, indent=4, sort_keys=True)) 174 | 175 | discard = ["code", "msg", "requestId", "success"] 176 | topic = config["mqtt"]["topic"] 177 | 178 | inverter_device_state = inverter_data["deviceState"] if inverter_data is not None and "deviceState" in inverter_data else None 179 | 180 | if inverter_device_state is None or station_data is None or logger_data is None or station_data is None: 181 | print(f"{time_stamp()}: 😡 Error: Unable to get inverter data") 182 | return 183 | 184 | if inverter_device_state == 1: 185 | print(f"{time.strftime('%Y-%m-%d %H:%M:%S')}: ⚡ Inverter DeviceState: {inverter_device_state} -> Publishing MQTT...") 186 | print(f"{time_stamp()}: ⚡ Sending station data to mqtt") 187 | for i in station_data: 188 | if station_data[i]: 189 | if i not in discard: 190 | mqtt.message(config["mqtt"], topic + "/station/" + i, station_data[i], config["debug"]) 191 | print(f"{time_stamp()}: ⚡ Sending inverter data to mqtt") 192 | for i in inverter_data: 193 | if inverter_data[i]: 194 | if i not in discard: 195 | mqtt.message(config["mqtt"], topic + "/inverter/" + i, inverter_data[i], config["debug"]) 196 | print(f"{time_stamp()}: ⚡ Sending inverter data list to mqtt") 197 | if inverter_data_list: 198 | mqtt.message(config["mqtt"], topic + "/inverter/attributes", json.dumps(inverter_data_list), config["debug"]) 199 | print(f"{time_stamp()}: ⚡ Sending logger data to mqtt") 200 | for i in logger_data: 201 | if logger_data[i]: 202 | if i not in discard: 203 | mqtt.message(config["mqtt"], topic + "/logger/" + i, logger_data[i], config["debug"]) 204 | print(f"{time_stamp()}: ⚡ Sending logger data list to mqtt") 205 | if logger_data_list: 206 | mqtt.message(config["mqtt"], topic + "/logger/attributes", json.dumps(logger_data_list), config["debug"]) 207 | print(f"{time.strftime('%Y-%m-%d %H:%M:%S')}: ⚡ Inverter DeviceState: {inverter_device_state} -> Publishing MQTT Completed") 208 | else: 209 | print(f"{time_stamp()}: ⚡ Device is not online (may be due to nighttime shutdown), sending only status to mqtt") 210 | mqtt.message(config["mqtt"], topic + "/inverter/deviceState", inverter_data["deviceState"], config["debug"]) 211 | mqtt.message(config["mqtt"], topic + "/logger/deviceState", logger_data["deviceState"], config["debug"]) 212 | print(f"{time.strftime('%Y-%m-%d %H:%M:%S')}: ⚡ Inverter DeviceState: {inverter_device_state} -> Only Status MQTT publish") 213 | 214 | 215 | if __name__ == "__main__": 216 | 217 | if sys.version_info < (3, 5): 218 | raise Exception("🐍 This script requires Python 3.5+") 219 | 220 | print(f"{time_stamp()}: ⚡ Starting Solarman data fetching...") 221 | 222 | config_file = CONFIG_PATH + "config.json" 223 | 224 | print(f"{time_stamp()}: 🕵️ Loading config file: {config_file}") 225 | 226 | if os.path.exists(config_file): 227 | config = load_config(config_file) 228 | interval = config.get("interval", 300) 229 | if(len(sys.argv) > 1): 230 | if(sys.argv[1] == "--repeat"): 231 | while True: 232 | run(config) 233 | print(f"{time_stamp()}: 💀 Sleeping for {interval} seconds...") 234 | time.sleep(interval) 235 | else: 236 | print(f"{time_stamp()}: ❓ Unrecognized parameter '" + sys.argv[1] + "'. Expected '--repeat', Stopping now.") 237 | else: 238 | print(f"{time_stamp()}: 🔥 Starting single run, use the argument '--repeat' to repeat at interval...") 239 | run(config) 240 | else: 241 | print(f"{time_stamp()}: 😡 Error reading config.json, sleeping 60sec before exit...") 242 | time.sleep(60) 243 | sys.exit(1) 244 | 245 | print(f"{time_stamp()}: 💀 Exiting...") 246 | time.sleep(1) 247 | sys.exit(0) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------