SinricPro Library
Loading...
Searching...
No Matches
SinricProGarageDoor

Device to control a garage door. More...

#include <SinricProGarageDoor.h>

Inheritance diagram for SinricProGarageDoor:

Public Member Functions

bool sendPushNotification (String notification)
 Sending push notifications to SinricPro App.
 
void onDoorState (DoorCallback cb)
 Set callback function for onDoorState request.
 
bool sendDoorStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
 Send DoorState event to update actual door state on SinricPro Server.
 

Detailed Description

Device to control a garage door.

Supporting

  • open / close

Member Function Documentation

◆ onDoorState()

void onDoorState ( DoorCallback  cb)
inherited

Set callback function for onDoorState request.

Parameters
cbFunction pointer to a onDoorState function
Returns
void
See also
DoorStateCallback

◆ sendDoorStateEvent()

bool sendDoorStateEvent ( bool  state,
String  cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION 
)
inherited

Send DoorState event to update actual door state on SinricPro Server.

Parameters
statebool true = close
false = open
cause(optional) String reason why event is sent (default = "PHYSICAL_INTERACTION")
Returns
the success of sending the even
Return values
trueevent has been sent successfully
falseevent has not been sent, maybe you sent to much events in a short distance of time

◆ sendPushNotification()

bool sendPushNotification ( String  notification)
inherited

Sending push notifications to SinricPro App.

Parameters
notificationString with the notification
Returns
the success of sending the event
Return values
trueevent has been sent successfully
falseevent has not been sent, maybe you sent to much events in a short distance of time