Difference between revisions of "Device Object"

From Hubitat Documentation
Jump to: navigation, search
Line 37: Line 37:
 
  void updateSetting(String name, Boolean value)
 
  void updateSetting(String name, Boolean value)
 
  void updateSetting(String name, String value)
 
  void updateSetting(String name, String value)
 +
void updateSetting(String name, Double value)
 +
void updateSetting(String name, Date value)
 +
void updateSetting(String name, List value)
 +
void removeSetting(String name)
 +
void clearSetting(String name)
 +
Long getIdAsLong()
 +
String getId()
 +
String getEndpointId()
 +
String getZigbeeId()
 +
Hub getHub()
 +
Map getData()
 +
void updateDataValue(String name, String value)
 +
String getDataValue(String name)
 +
String getDeviceDataByName(String name)
 +
String getStatus()
 +
String getName()
 +
void setName(String name)
 +
String getLabel()
 +
void setLabel(String label)
 +
String getDisplayName()
 +
void setDisplayName(String displayName)
 +
String getDeviceNetworkId()
 +
void setDeviceNetworkId(String dni)
 +
Object currentValue(String attributeName)
 +
State currentState(String attributeName)
 +
Object latestValue(String attributeName)
 +
State latestState(String attributeName)

Revision as of 15:50, 24 February 2019

eventsSince

Retrieve a list of events since a date/time.

Signature:

List<Event> eventsSince(Date startDate)
List<Event> eventsSince(Date startDate, Map options)

Parameters:

startDate - The date/time to list events since.
options - Map with optional settings for the return value, possible value is max which is the maximum number of rows to return, default value is 10.

Returns:

A list of Events

Examples:

// Get events since 8:00 am today def events = eventsSince(timeToday("08:00"))

// Get a maximum of 5 events def events = eventsSince(timeToday("08:00"), [max:5])


Additional to be documented

List<Event> eventsBetween(Date startDate, Date endDate)
List<Event> eventsBetween(Date startDate, Date endDate, Map options = null)
List<State> statesSince(String attributeName, Date startDate)
List<State> statesSince(String attributeName, Date startDate, Map options = null)
List<Event> events()
List<Event> events(Map options)
void sendEvent(Map properties)
void updateSetting(String name, Map options)
void updateSetting(String name, Long value)
void updateSetting(String name, Boolean value)
void updateSetting(String name, String value)
void updateSetting(String name, Double value)
void updateSetting(String name, Date value)
void updateSetting(String name, List value)
void removeSetting(String name)
void clearSetting(String name)
Long getIdAsLong()
String getId()
String getEndpointId()
String getZigbeeId()
Hub getHub()
Map getData()
void updateDataValue(String name, String value)
String getDataValue(String name)
String getDeviceDataByName(String name)
String getStatus()
String getName()
void setName(String name)
String getLabel()
void setLabel(String label)
String getDisplayName()
void setDisplayName(String displayName)
String getDeviceNetworkId()
void setDeviceNetworkId(String dni)
Object currentValue(String attributeName)
State currentState(String attributeName)
Object latestValue(String attributeName)
State latestState(String attributeName)