Metadata-Version: 2.1
Name: epevermodbus
Version: 0.0.11
Summary: UNKNOWN
Home-page: https://github.com/rosswarren/epevermodbus
Author: Ross Warren
Author-email: rosswarren4@gmail.com
License: MIT
Description: # epevermodbus
        
        This package is intended to help you communicate with an EPever charge controller. It has been tested with an EPever Tracer AN but should work with other devices.
        
        ## Connecting to the charge controller
        
        You have two options
        
        * Official EPever cable
        * Your own custom cable
        
        ## Installing the package
        
        To install the package run
        
        ```sh
        pip install epevermodbus
        ```
        
        ## Command line utility
        
        To run the command line utility and see the debug output run the following on the command line:
        
        ```sh
        epevermodbus --portname /dev/ttyUSB0 --slaveaddress 1
        ```
        
        ```sh
        usage: epevermodbus [-h] [--portname PORTNAME] [--slaveaddress SLAVEADDRESS]
        
        optional arguments:
          -h, --help            show this help message and exit
          --portname PORTNAME   Port name for example /dev/ttyUSB0
          --slaveaddress SLAVEADDRESS
                                Slave address 1-247
        ```
        
        Example output
        
        ```sh
        Real Time Data
        Solar voltage: 0.02
        Solar current: 0.0
        Solar power: 0.0
        Solar power L: 0.0
        Solar power H: 0.0
        Load voltage: 0.0
        Load current: 0.0
        Load power: 0.0
        Load power L: 0.0
        Load power H: 0.0
        Battery current L: 0.0
        Battery current H: 0.0
        Battery voltage: 13.27
        Battery state of charge: 0.87
        Battery temperature: 17.2
        Remote battery temperature: 0.0
        Controller temperature: 16.81
        Battery status: {'wrong_identifaction_for_rated_voltage': False, 'battery_inner_resistence_abnormal': False, 'temperature_warning_status': 'NORMAL', 'battery_status': 'NORMAL'}
        Charging equipment status: {'input_voltage_status': 'NORMAL', 'charging_mosfet_is_short_circuit': False, 'charging_or_anti_reverse_mosfet_is_open_circuit': False, 'anti_reverse_mosfet_is_short_circuit': False, 'input_over_current': False, 'load_over_current': False, 'load_short_circuit': False, 'load_mosfet_short_circuit': False, 'disequilibrium_in_three_circuits': False, 'pv_input_short_circuit': False, 'charging_status': 'NO_CHARGING', 'fault': False, 'running': True}
        Discharging equipment status: {'input_voltage_status': 'NORMAL', 'output_power_load': 'LIGHT', 'short_circuit': False, 'unable_to_discharge': False, 'unable_to_stop_discharging': False, 'output_voltage_abnormal': False, 'input_over_voltage': False, 'short_circuit_in_high_voltage_side': False, 'boost_over_voltage': False, 'output_over_voltage': False, 'fault': False, 'running': False}
        Day time: False
        Night time: True
        Maximum battery voltage today: 14.5
        Minimum battery voltage today: 13.25
        Device over temperature: False
        
        
        Battery Parameters:
        Rated charging current: 20.0
        Rated load current: 20.0
        Battery real rated voltage: 12.0
        Battery type: USER_DEFINED
        Battery capacity: 40
        Temperature compensation coefficient: 0
        Over voltage disconnect voltage: 14.7
        Charging limit voltage: 14.4
        Over voltage reconnect voltage: 14.6
        Equalize charging voltage: 14.4
        Boost charging voltage: 14.4
        Float charging voltage: 13.6
        Boost reconnect charging voltage: 13.3
        Low voltage reconnect voltage: 12.0
        Under voltage recover voltage: 12.0
        Under voltage warning voltage: 11.5
        Low voltage disconnect voltage: 11.0
        Discharging limit voltage: 11.0
        ```
        
        ## Python usage
        
        To use the library within your Python code
        
        ```python
        from epevermodbus.driver import EpeverChargeController
        
        
        controller = EpeverChargeController("/dev/ttyUSB0", 1)
        
        controller.get_solar_voltage()
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
