Package dev.cookiecode.rika2mqtt.rika.firenet

Interface RikaFirenetService

All Known Implementing Classes:

RikaFirenetServiceImpl

public interface RikaFirenetService

Author:

Sebastien Vermeille

Method Summary

Modifier and Type	Method	Description
StoveStatus	getStatus(@NonNull StoveId stoveId)	Get status of a stove
List<StoveId>	getStoves()	Get stoves ids associated to the rika account defined in RikaFirenetConfiguration
boolean	isAuthenticated()	Indicate if the auth with rika-firenet is done or not.
boolean	isValidCredentials(String email, String password)	Attempt to perform a login to rika-firenet using given credentials.
void	updateControls(@NonNull StoveId stoveId, Map<String,String> fields)	Update stove controls (such as target temperature, on/off, heating mode, multiair, etc.)

Method Details

getStoves

List<StoveId> getStoves()

Get stoves ids associated to the rika account defined in RikaFirenetConfiguration

Returns:

list of stove ids

getStatus

StoveStatus getStatus(@NonNull
 @NonNull StoveId stoveId)
               throws InvalidStoveIdException,
CouldNotAuthenticateToRikaFirenetException,
UnableToRetrieveRikaFirenetDataException

Get status of a stove

Parameters:

stoveId - the id of the stove

Returns:

the complete status of a stove

Throws:

InvalidStoveIdException - when the given stoveId is not valid

CouldNotAuthenticateToRikaFirenetException - when could not auth to rika firenet

UnableToRetrieveRikaFirenetDataException

isAuthenticated

boolean isAuthenticated()

Indicate if the auth with rika-firenet is done or not.

Returns:

true when authenticated successfully to rika.

isValidCredentials

boolean isValidCredentials(String email,
 String password)

Attempt to perform a login to rika-firenet using given credentials.

Parameters:

email - rika account email (username)

password - rika account password

Returns:

true when the given credentials are valid.

updateControls

void updateControls(@NonNull
 @NonNull StoveId stoveId,
 Map<String,String> fields)
             throws UnableToControlRikaFirenetException,
InvalidStoveIdException,
OutdatedRevisionException

Update stove controls (such as target temperature, on/off, heating mode, multiair, etc.)

Parameters:

stoveId - Id of the stove to perform update on

fields - You can provide any of these UpdatableControls.Fields and rika2mqtt will manage to do the rest.

Throws:

UnableToControlRikaFirenetException

InvalidStoveIdException

OutdatedRevisionException