Metadata-Version: 2.1
Name: aristonremotethermo
Version: 1.0.14
Summary: Ariston NET Remotethermo integration
Home-page: https://github.com/chomupashchuk/ariston-remotethermo-api
Author: Oleh Pashchuk
Author-email: chomu.nattsol@gmail.com
License: MIT
Download-URL: https://pypi.org/project/aristonremotethermo/
Keywords: Ariston NET,Remotethermo,Ariston
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: requests

# Ariston NET remotethermo API
Thin integration is a side project which works only with 1 zone climate configured. It logs in to Ariston website (https://www.ariston-net.remotethermo.com) and fetches/sets data on that site.
You are free to modify and distribute it. It is distributed 'as is' with no liability for possible damage.

## API and Home Assistant
API was created in order to be used by Home Assistant. Example of API use for Home Assistant can be found: https://github.com/chomupashchuk/ariston-remotethermo-home-assistant-v2 and https://github.com/chomupashchuk/ariston-aqua-remotethermo-home-assistant

## API slow nature
API connect to the website, which then connect via gateway to the boiler. The bus has problem handling high bandwidth and thus requests are sent after some specific periods of time. Periods were selected based on tests where not much of interfence was seen when using Ariston Net application or Google Home application or using https://www.ariston-net.remotethermo.com. Still interfences occaionally take place. It is normal to occasionally get connection errors due to devices chain involved.

## AristonHandler was tested on and works with:
  - Ariston Clas Evo
  - Ariston Genus One with Ariston BCH cylinder
  - Ariston Nimbus Flex
You may check possible support of your boiler by logging into https://www.ariston-net.remotethermo.com and if climate and water heater parts (like temperatures) are available on the home page, then intergation should potentially work.

## AquaAristonHandler was tested works with:
  - Ariston Velis Wifi
  - Ariston Lydos
You may check possible support of your boiler by logging into https://www.ariston-net.remotethermo.com and if login is successful but no climate or water heater is present.

## API use
### API import
Install package:
```
pip install aristonremotethermo
```
Import class `AristonHandler`:
```
from aristonremotethermo.ariston import AristonHandler
```
Import class `AquaAristonHandler`:
```
from aristonremotethermo.aristonaqua import AquaAristonHandler
```

### API dependencies
  - `requests` - used for HTTPS requests towards https://www.ariston-net.remotethermo.com.

### AristonHandler start communication
```
from aristonremotethermo.ariston import AristonHandler

ApiInstance = AristonHandler(
            username='username',
            password='password'
        )

ApiInstance.start()
```
See `help(AristonHandler)` on how to properly initiate API.

### AquaAristonHandler start communication
```
from aristonremotethermo.aristonaqua import AquaAristonHandler

ApiInstanceAqua = AquaAristonHandler(
            username='username',
            password='password'
        )

ApiInstanceAqua.start()
```
See `help(AquaAristonHandler)` on how to properly initiate API.


### AristonHandler stop communication
```
ApiInstance.stop()
```

### AquaAristonHandler stop communication
```
ApiInstanceAqua.stop()
```

### API properties
See `help(AristonHandler)` and `help(AquaAristonHandler)`.

### AristonHandler change of data on remote server
```
ApiInstance.set_http_data(parameter1=value1,parameter2=value2,...)
```
Method sets values for specific parameter names (see property `supported_sensors_set_values` from `help(AristonHandler)`) on the remote server.

#### AristonHandler change of data example
```
ApiInstance.set_http_data(mode="winter",ch_mode="scheduled")
```

### AquaAristonHandler change of data on remote server
```
ApiInstanceAqua.set_http_data(parameter1=value1,parameter2=value2,...)
```
Method sets values for specific parameter names (see property `supported_sensors_set_values` from `help(AquaAristonHandler)`) on the remote server.

#### AquaAristonHandler change of data example
```
ApiInstanceAqua.set_http_data(mode="manual")
```

# Version 1.0.14
- code cleanup;

# Version 1.0.13
- code cleanup;
- additional class for handling Velis is introduced;

# Version 1.0.12
- DHW and CH availability status update;

# Version 1.0.11
- Code cleanup;

# Version 1.0.10
- Folder creation handling for data store is updated;

# Version 1.0.9
- Change the way changed temperature is visualized;

# Version 1.0.8
- Change the way floats are compared in all places;
- More flexible data types are allowed in set_http_data method;

# Version 1.0.7
- Help annotations update;

# Version 1.0.6
- Changed algorithm to visualize temperatures when changing their values;

# Version 1.0.5
- Help update;

# Version 1.0.4
- Initial release;

