ankersolixe1600

1.0.5 • Public • Published

Contributors Forks Stargazers Issues Apache 2.0 LinkedIn


Logo

Anker Solix E1600

Smart Solar, Bright Tomorrow: Making Every Ray Count.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Anker Solix Solarbank E1600 - Node Library

Welcome to our ANKER Solix Solarbank E1600 Management Adapter! Please read on to discover how this project can empower you to optimize your Micro-PV (Photovoltaic) plant, enabling efficient energy management and increased self-consumption of solar power.

Project Background

Our project was initiated with a clear mission: to provide remote support for our clients who utilize ANKER Solix Solarbank E1600, without any affiliation with the manufacturer, Anker Power. We recognize the importance of independence and impartiality, ensuring that our users receive unbiased, top-quality support and solutions.

Project Goals

  • Remote Support: We aim to offer seamless remote support to our clients, enabling them to resolve issues and optimize their solar energy systems from anywhere, at any time.
  • Integration into Energy Management Systems: Our project facilitates the seamless integration of ANKER Solix Solarbank E1600 into various energy management systems. This integration empowers users with comprehensive control over their energy production and consumption.
  • Optimization of Self-Consumption: One of the core objectives of our project is to optimize the self-consumption of PV power.

By intelligently managing the generation peaks and storing excess electricity for later use, we help our users maximize their energy efficiency.

(back to top)

Getting Started

This section will walk you through the essential steps to set up the library, providing you with options to test its functionalities conveniently.

Installation:

Start by installing the library using your preferred package manager. For example, if you're using Node.js, you can install it via npm:

For embeddding into your project

npm install --save ankersolixe1600

For Command-Line-Usage (CLI)

npm install -g ankersolixe1600

For NodeRED usage

  • Open Palet Manager
  • Install ankersolixe1600

Integrating the Library

Our library is designed with seamless integration in mind, allowing you to harness the power of ANKER Solix Solarbank E1600 within your own codebase. To begin, follow these steps:

(back to top)

Usage

Check the cli.js file to see how we are using the library.

(back to top)

Authentication

This libraray/module uses the APP login credentials of the Anker APP to authenticate with the Anker Cloud Service.

Step 1: User Authentication

To start the login process, provide your username and password. These credentials are necessary to establish a secure connection with the Anker Cloud Service:

const mysolix = new SolixE1600({
  username: 'EmailAsUsedInAnkerApp',
  password: 'AccountPassword',
  country: '2-Letter-Country-Code'
});

Step 2: Obtaining the auth_token

After successful authentication, you will receive an auth_token. This token acts as a session identifier, allowing you to perform actions on behalf of your account. Safeguard this token as it grants access to your session.

Important Note: Single Device Login

Please note that Anker Cloud Service allows only one device to be logged in at a time. If you attempt to log in from another device while already logged in, the existing session will be terminated.

Daily Login Limits

Additionally, be aware that the Anker Cloud Service imposes restrictions on the number of logins permitted per day. Make sure to stay within the allowed limits to avoid interruptions in your service.

Best Practice: Handling Multiple Instances

If you are instantiating this library/module multiple times within your application, it is advisable to manage your sessions efficiently. One recommended approach is to save the session login configuration using the getSessionConfiguration() method. By doing so, you can maintain a coherent login state across all instances, ensuring a seamless experience for your users.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the Apache-2.0 License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

Inspired by the work of the Solix2MQTT Project

Maintainer / Imprint

STROMDAO GmbH
Gerhard Weiser Ring 29
69256 Mauer
Germany

+49 6226 968 009 0

kontakt@stromdao.com

Handelsregister: HRB 728691 (Amtsgericht Mannheim)

https://stromdao.de/

(back to top)

Package Sidebar

Install

npm i ankersolixe1600

Weekly Downloads

11

Version

1.0.5

License

Apache-2.0

Unpacked Size

115 kB

Total Files

14

Last publish

Collaborators

  • zoernert