Package dev.cookiecode.rika2mqtt.rika.firenet

Class RikaFirenetServiceImpl

java.lang.Object

dev.cookiecode.rika2mqtt.rika.firenet.RikaFirenetServiceImpl

All Implemented Interfaces:

RikaFirenetService

@Service
public class RikaFirenetServiceImpl
extends Object
implements RikaFirenetService

Author:

Sebastien Vermeille

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEEP_ALIVE_NOTIFICATION

Constructor Summary

Constructors

Constructor	Description
RikaFirenetServiceImpl()

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.)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEEP_ALIVE_NOTIFICATION

public static final String KEEP_ALIVE_NOTIFICATION

See Also:

• Constant Field Values

Constructor Details

RikaFirenetServiceImpl

public RikaFirenetServiceImpl()

Method Details

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: RikaFirenetService

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

Specified by:

isAuthenticated in interface RikaFirenetService

Returns:

true when authenticated successfully to rika.

isValidCredentials

public boolean isValidCredentials(String email,
 String password)

Description copied from interface: RikaFirenetService

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

Specified by:

isValidCredentials in interface RikaFirenetService

Parameters:

email - rika account email (username)

password - rika account password

Returns:

true when the given credentials are valid.

updateControls

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

Description copied from interface: RikaFirenetService

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

Specified by:

updateControls in interface RikaFirenetService

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

getStoves

public List<StoveId> getStoves()

Description copied from interface: RikaFirenetService

Get stoves ids associated to the rika account defined in RikaFirenetConfiguration

Specified by:

getStoves in interface RikaFirenetService

Returns:

list of stove ids

getStatus

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

Description copied from interface: RikaFirenetService

Get status of a stove

Specified by:

getStatus in interface RikaFirenetService

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