71
Most functions use alias parameter object group address or unique object name. (e.g. '1/1/1'
or 'My object')
grp.getvalue(alias)
Returns value for the given alias or Lua nil when object cannot be found.
grp.find(alias)
Returns single object for the given alias. Object value will be decoded automatically only if the
data type has been specified in the 'Objects' module. Returns Lua nil when object cannot be
found, otherwise it returns Lua table with the following items:
address object group address
updatetime latest update time in UNIX timestamp format. Use Lua os.date() to convert
to readable date formats
When object data type has been specified in the 'Objects' module the following fields are
available:
name unique object name
datatype object data type as specified by user
decoded set to true when decoded value is available
value decoded object value
grp.tag(tags, mode)
Returns Lua table containing objects with the given tag. Tags parameter can be either
Lua table or a string. Mode parameter can be either 'all' (return objects that have all of the
given tags) or 'any' (default returns objects that have any of the given tags). You can
useReturned object functions on the returned table.
grp.alias(alias)
Converts group address to object name or name to address. Returns Lua nil when object cannot
be found.
6.1.9. Returned object functions, group communication functions
Objects received by using grp.find(alias) or grp.tag(tags, mode) have the following functions
attached to them:
Always check that the returned object was found otherwise calling these functions will result in
an error. See the example below.
object:write(value, datatype)
Sends group write request to object's group address. Data type is taken from the database if
not specified as second parameter. Returns Lua boolean as the result.
To Next Page
Need help?
General