List of Functions

Category	Method	Description
XML-RPC	system.getCapabilities	Lists Homegear's RPC capabilities
XML-RPC	system.listMethods	Lists all supported RPC methods
XML-RPC	system.methodHelp	Returns the short description of an RPC method
XML-RPC	system.methodSignature	Returns an RPC method's signature
XML-RPC	system.multicall	Use this method to call multiple RPC methods at once in order to reduce traffic.
General	getInstanceId	Returns the unique Homegear instance ID
General	getServiceMessages	Returns all service messages
General	getVersion	Returns Homegear's version number
General	logLevel	Gets or sets the current log level
General	runScript	Executes a script located in Homegear's script directory
General	setLanguage	Sets the language of the connection.
General	writeLog	Writes a message to the Homegear log
Database	deleteData	Deletes previously stored data from Homegear's key-value database
Database	getData	Retrieves previously stored data from Homegear's key-value database
Database	setData	Stores data in Homegear's key-value database
Devices	activateLinkParamset	Simulates a remote key press
Devices	addLink	Creates a direct link between two devices
Devices	copyConfig	Copies configuration parameters from one channel to another
Devices	deleteDevice	Unpairs a peer or resets it to factory defaults
Devices	getAllConfig	Returns all peer configuration parameters and some additional metadata
Devices	getAllValues	Returns all peer configuration parameters and some additional metadata
Devices	getDeviceDescription	Returns static information about a device
Devices	getDeviceInfo	Returns dynamic information about a device
Devices	getLinkInfo	Returns name and description of a direct device link
Devices	getLinkPeers	Returns all peers and channels a channel is linked to
Devices	getLinks	Returns direct links of all or a single peer
Devices	getName	Returns the name of a peer
Devices	getParamset	Returns a peer's configuration parameters
Devices	getParamsetDescription	Returns information about a peer's parameter set
Devices	getParamsetId	Returns the ID of a parameter set
Devices	getPeerId	Returns all peers matching a filter condition
Devices	getValue	Returns the value of a device variable
Devices	listDevices	Lists information about all existing peers
Devices	listTeams	Lists information about all existing teams
Devices	putParamset	Sets device configuration parameters
Devices	removeLink	Removes a direct link between two devices
Devices	setId	Changes the ID of a peer
Devices	setName	Sets the name of a peer
Devices	setTeam	Adds a device to or removes it from a team
Devices	setValue	Sets the value of a device variable
Events	abortEventReset	Aborts an event's reset timer
Events	addEvent	Creates an event to Homegear's event engine
Events	enableEvent	Enables or disables an event
Events	getEvent	Returns EventDescription for a single event
Events	listEvents	Returns all events
Events	removeEvent	Removes an event
Events	triggerEvent	Manually triggers an event
Event Server	clientServerInitialized	Checks if an RPC client's RPC server was successfully registered and if it still is registered
Event Server	init	Registers a client's RPC server with Homegear to receive events
Event Server	listClientServers	Returns information about all RPC servers registered with Homegear by clients
Event Server	subscribePeers	Subscribes peer events that are to be sent to an event server when the init flag "subscribePeers" is used
Event Server	triggerRpcEvent	Manually sends an RPC event to all RPC event servers
Event Server	unsubscribePeers	Unsubscribes peer events after subscribing them with subscribePeers
Families	listFamilies	Returns information about all device families (ID, name, pairing methods)
Firmware Updates	getUpdateStatus	Returns firmware update status information
Firmware Updates	updateFirmware	Updates the firmware of a device
InfluxDB	influxdbCreateContinuousQuery	Creates a continuous query for number measurements with Homegear's default settings to store aggregated data in the low resolution table
InfluxDB	influxdbGetDatabase	Returns the name of the InfluxDB database used by Homegear
InfluxDB	influxdbGetLoggedVariables	Returns all variables logged by Homegear InfluxDB
InfluxDB	influxdbQuery	Executes an InfluxDB query
InfluxDB	influxdbSetLogging	Enables automatic logging of values for a specific variable in InfluxDB
InfluxDB	influxdbWrite	Executes an InfluxDB write
Metadata	deleteMetadata	Deletes previously stored metadata
Metadata	getAllMetadata	Returns all the metadata of one peer
Metadata	getMetadata	Retrieves previously stored metadata
Metadata	setMetadata	Stores metadata for a peer
Node-BLUE	getNodeVariable	Executes "getNodeVariable" in the specified node.
Node-BLUE	setNodeVariable	Executes "setNodeVariable" in the specified node.
Pairing	addDevice	Pairs a device without enabling pairing mode
Pairing	createDevice	Manually creates a device
Pairing	getInstallMode	Returns the time left in pairing mode
Pairing	getPairingInfo	Returns information about communication modules and how devices of a family are paired
Pairing	searchDevices	Starts a device search for all supported device families
Pairing	setInstallMode	Enables pairing mode
Physical Interfaces	listBidcosInterfaces	This method exists only for compatibility reasons.
Physical Interfaces	listInterfaces	Lists all physical interfaces with status information
Physical Interfaces	setInterface	Sets the physical interface Homegear uses to communicate with a peer
Roles	addRoleToVariable	Adds a role to a variable
Roles	aggregateRoles	Aggregates values of variables with specific roles
Roles	createRole	Creates a new role
Roles	deleteRole	Deletes a role
Roles	getRoleMetadata	Returns the metadata of an existing role
Roles	getRoles	Returns information about all roles
Roles	getVariablesInRole	Returns all variables of a role
Roles	removeRoleFromVariable	Removes a role from a variable
Roles	setRoleMetadata	Sets the metadata of an existing role
Roles	updateRole	Updates the translations and metadata of an existing role
Rooms and Categories	addBuildingPartToBuilding	Assigns a building part to a building
Rooms and Categories	addCategoryToChannel	Adds a category to a channel
Rooms and Categories	addCategoryToDevice	Adds a category to a device
Rooms and Categories	addCategoryToSystemVariable	Adds a category to a system variable
Rooms and Categories	addCategoryToVariable	Adds a category to a variable
Rooms and Categories	addChannelToRoom	Assigns a channel to a room
Rooms and Categories	addDeviceToRoom	Assigns a device to a room
Rooms and Categories	addRoomToStory	Assigns a room to a story
Rooms and Categories	addStoryToBuilding	Assigns a story to a building
Rooms and Categories	addSystemVariableToRoom	Assigns a system variable to a room
Rooms and Categories	addVariableToRoom	Assigns a variable to a room
Rooms and Categories	createBuilding	Creates a new building
Rooms and Categories	createBuildingPart	Creates a new building part
Rooms and Categories	createCategory	Creates a new category
Rooms and Categories	createRoom	Creates a new room
Rooms and Categories	createStory	Creates a new story
Rooms and Categories	deleteBuilding	Deletes a building
Rooms and Categories	deleteBuildingPart	Deletes a building part
Rooms and Categories	deleteCategory	Deletes a category
Rooms and Categories	deleteRoom	Deletes a room
Rooms and Categories	deleteStory	Deletes a story
Rooms and Categories	getBuildingMetadata	Returns the metadata of an existing building
Rooms and Categories	getBuildingPartMetadata	Returns the metadata of an existing building part
Rooms and Categories	getBuildingParts	Returns information about all building parts
Rooms and Categories	getBuildingPartsInBuilding	Returns all building parts of a building
Rooms and Categories	getBuildings	Returns information about all buildings
Rooms and Categories	getCategories	Returns information about all categories
Rooms and Categories	getCategoryMetadata	Returns the metadata of an existing category
Rooms and Categories	getChannelsInCategory	Returns all channels of a category
Rooms and Categories	getChannelsInRoom	Returns all channels of a room
Rooms and Categories	getDevicesInCategory	Returns all devices of a category
Rooms and Categories	getDevicesInRoom	Returns all devices of a room
Rooms and Categories	getRoomMetadata	Returns the metadata of an existing room
Rooms and Categories	getRooms	Returns information about all rooms
Rooms and Categories	getRoomsInStory	Returns all rooms of a story
Rooms and Categories	getStories	Returns information about all stories
Rooms and Categories	getStoriesInBuilding	Returns all stories of a building
Rooms and Categories	getStoryMetadata	Returns the metadata of an existing story
Rooms and Categories	getSystemVariablesInCategory	Returns all system variables of a category
Rooms and Categories	getSystemVariablesInRoom	Returns all system variables of a room
Rooms and Categories	getVariablesInCategory	Returns all variables of a category
Rooms and Categories	getVariablesInRoom	Returns all variables of a room
Rooms and Categories	removeBuildingPartFromBuilding	Removes a building part from a building
Rooms and Categories	removeCategoryFromChannel	Removes a category from a channel
Rooms and Categories	removeCategoryFromDevice	Removes a category from a device
Rooms and Categories	removeCategoryFromSystemVariable	Removes a category from a system variable
Rooms and Categories	removeCategoryFromVariable	Removes a category from a variable
Rooms and Categories	removeChannelFromRoom	Removes a channel from a room
Rooms and Categories	removeDeviceFromRoom	Removes a device from a room
Rooms and Categories	removeRoomFromStory	Removes a room from a story
Rooms and Categories	removeStoryFromBuilding	Removes a story from a building
Rooms and Categories	removeSystemVariableFromRoom	Removes a system variable from a room
Rooms and Categories	removeVariableFromRoom	Removes a variable from a room
Rooms and Categories	setBuildingMetadata	Sets the metadata of an existing building
Rooms and Categories	setBuildingPartMetadata	Sets the metadata of an existing building part
Rooms and Categories	setCategoryMetadata	Sets the metadata of an existing category
Rooms and Categories	setRoomMetadata	Sets the metadata of an existing room
Rooms and Categories	setStoryMetadata	Sets the metadata of an existing story
Rooms and Categories	updateBuilding	Updates the translations and metadata of an existing building
Rooms and Categories	updateBuildingPart	Updates the translations and metadata of an existing building part
Rooms and Categories	updateCategory	Updates the translations and metadata of an existing category
Rooms and Categories	updateRoom	Updates the translations and metadata of an existing room
Rooms and Categories	updateStory	Updates the translations and metadata of an existing story
System Variables	deleteSystemVariable	Deletes a system variable
System Variables	getAllSystemVariables	Returns all system variables
System Variables	getSystemVariable	Gets the value of a system variable
System Variables	getSystemVariableFlags	Returns the flags assigned to a system variable
System Variables	setSystemVariable	Creates or updates a system variable
UI	addUiElement	Adds an UI element to Homegear's UI
UI	checkUiElementSimpleCreation	Checks if automatic UI element creation is possible on a variable
UI	createUiNotification	Creates a new UI notification
UI	getAllUiElements	Returns all UI elements
UI	getAvailableUiElements	Returns UI elements that can be added
UI	getCategoryUiElements	Returns all UI elements assigned to a category
UI	getRoomUiElements	Returns all UI elements assigned to a room
UI	getUiElementMetadata	Gets metadata of an UI element
UI	getUiNotification	Returns a single UI notification
UI	getUiNotifications	Returns all UI notifications
UI	removeUiElement	Sets metadata of an UI element
UI	removeUiNotification	Removes an UI notification
UI	requestUiRefresh	Requests the UI to be reloaded
UI	setUiElementMetadata	Sets metadata of an UI element
UI	uiNotificationAction	Trigger a UI notification button action
Variable Profiles	activateVariableProfile	Activates a variable profile (= "scene")
Variable Profiles	addVariableProfile	Adds an UI element to Homegear's UI (= "scene")
Variable Profiles	deleteVariableProfile	Deletes a variable profile (= "scene")
Variable Profiles	getAllVariableProfiles	Returns all variable profiles (= "scenes")
Variable Profiles	getVariableProfile	Returns a single variable profile (= "scene")
Variable Profiles	updateVariableProfile	Updates an existing variable profile (= "scene")

List of Event Server Functions

A client can implement an event server to receive events from Homegear. To register an event server with Homegear, call init() (not necessary for WebSockets, MQTT or Unix Domain Sockets).

For JSON-RPC, XML-RPC and Binary RPC Homegear checks which methods are implemented by calling system.listMethods(). That means not all methods need to be implemented.
The method event() is always wrapped in system.multicall even when only one event is broadcast. The reason for this is that some clients do not support event() without it.

Category	Method	Description
Event Server - Devices	event	Called on variable changes
Event Server - General	error	Called when an error occurs in Homegear
Event Server - UI	requestUiRefresh	Requests the UI to be reloaded
Event Server - UI	uiNotificationAction	Called when a UI notification button is pressed
Event Server - UI	uiNotificationCreated	Called when there is a new UI notification
Event Server - UI	uiNotificationRemoved	Called when a new UI notification has been removed
Event Server - Variable Profiles	variableProfileStateChanged	Called when a variable profile changes it's state

Overview

General

Homegear supports different communication protocols:

XML-RPC: Easy to use and implemented in most programming languages.
Binary-RPC: Fast en- and decoding
JSON-RPC: Also easy to use.
WebSockets: For communication between Homegear and web browser (see HomegearWS)
MQTT: Popular protocol specialized for the Internet of Things.
IPC / Unix Domain Sockets: For communication between Homegear and other programs running on the same system.

Each supported protocol supports all RPC methods in this reference. Additionally all RPC methods can be called in Homegear's script engine.

The RPC methods are based on and compatible to the methods defined in the specification of the HomeMatic XML-RPC Interface. For more information and for implementation examples see the Homegear Documentation.

XML-RPC Types

These types defined by the XML-RPC Specification are supported by Homegear:

Tag	Type	Example / Notes
<i4> or <int>	Four-byte signed integer	`-12`
<i8>	Eight-byte signed integer	`55247185375`
<boolean>	0 (false) or 1 (true)	`1`
<string>	String. > and & need to be escaped.	`Hello world > &`
<double>	Double-precision signed floating point number	`-12.214`
<base64>	base64-encoded binary data	`eW91IGNhbid0IHJlYWQgdGhpcyE=`
<struct>	Associative array	`<struct> <member> <name>lowerBound</name> <value><i4>18</i4></value> </member> <member> <name>upperBound</name> <value><i4>139</i4></value> </member> </struct>`
<array>	Non-associative array	`<array> <data> <value><i4>12</i4></value> <value><string>Egypt</string></value> <value><boolean>0</boolean></value> <value><i4>-31</i4></value> </data> </array>`
<nil> or <ex:nil>	Void	Homegear accepts or but does not send them!

Homegear-specific Types

In addition to the basic types, Homegear defines the following structures:

DeviceDescription

The struct DeviceDescription describes one HomeMatic device. One HomeMatic device has multiple device descriptions:

One for the parent device
and one for each channel (0, 1, ...)

Enumerations used in DeviceDescription

Name	Values	Description
Flags	1	Visible: Device should be visible to the user
	2	Internal: Device is only used internally
	8	Dontdelete: Device can't (or shouldn't) be deleted
Direction	0	DIRECTION_NONE (no links are supported)
	1	DIRECTION_SENDER
	2	DIRECTION_RECEIVER
RXMode	1	RX_ALWAYS: Device is always in RX mode
	2	RX_BURST: Device is in "wake on radio" mode and can be woken up with "wake on radio" packets
	4	RX_CONFIG: Device can be reached by enabling the pairing mode
	8	RX_WAKEUP: Device sends cyclic "wake me up" packets and is only reachable every 2 to 3 minutes
	16	RX_LAZY_CONFIG: Device accepts config packets after normal packets (e. g. a packet from a remote)

Members

DeviceDescription of Parent Device

Name	Type	Description
FAMILY	Integer	The ID of the family the device belongs to (e. g. 0 for HomeMatic BidCoS, 1 for HomeMatic Wired, 2 for Insteon, ...)
TYPE	String	Type of the device
TYPE_ID	Integer	The type ID of the device
DESCRIPTION	String	A short description of the device
LONG_DESCRIPTION	String	A description of the device
ID	Integer	The id of the device (e. g. 131)
ADDRESS	String	Serialnumber of the device (e. g. JEQ0123456)
CHILDREN	Array<String>	For compatibility. Addresses of the channels (e. g. JEQ0123456:1)
CHANNELS	Array<Integer>	Indexes of all available channels
PARENT	String	Empty for parent device
PARAMSETS	Array<String>	Names of the available parameter sets (MASTER, VALUES and/or LINK)
FIRMWARE	String	Optional. Firmware version (e. g. "2.1"). "?" for teams.
AVAILABLE_FIRMWARE	String	Optional. Firmware version available for update (e. g. "2.2"). Only set when a newer firmware version is available.
VERSION	Integer	Version of the XML file
FLAGS	Flags	or-linked flags for the GUI
RF_ADDRESS	Integer	For compatability. Physical address of the device.
PHYSICAL_ADDRESS	Integer	Physical address of the device
RX_MODE	RXMode	The supported RX modes of the device.
INTERFACE	String	Only for compatibility. Serial number of the central.
ROOM	Integer	The ID of the room assigned to this device. Only returned if set and if specified in parameter fields.
CATEGORIES	Array<Integer>	The IDs of the categories assigned to this device. Only returned if at least one category is set and if specified in parameter fields.

DeviceDescription of Channel

Name	Type	Description
TYPE	String	Type of the channel
FAMILY	Integer	The ID of the family the device belongs to (e. g. 0 for HomeMatic BidCoS, 1 for HomeMatic Wired, 2 for Insteon, ...)
ID	Integer	The id of the device (e. g. 131)
CHANNEL	Integer	The channel number (e. g. 2)
ADDRESS	String	Serialnumber and index of the channel (e. g. JEQ0123456:1)
PARENT	String	Serialnumber of parent device (e. g. JEQ0123456)
PARENT_TYPE	String	Type of the parent device
INDEX	Integer	Channel number
AES_ACTIVE	Integer	"1" when AES handshakes are enabled for the channel otherwise "0". This variable is of type Integer for compatibility.
PARAMSETS	Array<String>	Names of the available parameter sets (MASTER, VALUES and/or LINK)
VERSION	Integer	Version of the XML file
FLAGS	Flags	or-linked flags for the GUI
LINK_SOURCE_ROLES	String	Source roles defined for this channel in the XML file seperated by space
LINK_TARGET_ROLES	String	Target roles defined for this channel in the XML file seperated by space
DIRECTION	Direction	Direction of the channel (sender or receiver)
GROUP	String	Optional. Only when device has grouped channels. Serial number and index of the grouped channel (e. g. JEQ0123456:3)
TEAM	String	Optional. Only when channel supports teams. Serial number of the team (e. g. JEQ0123456 - note the "")
TEAM_TAG	String	Optional. Only when channel supports teams or for teams. Type of the team ("team_tag" attribute of the team's XML file).
TEAM_CHANNELS	Array<String>	Optional. Only for teams. Array of peers (serialnumber and channel) paired to this team (e. g. JEQ0234567:1)
ROOM	Integer	The ID of the room assigned to this channel. Only returned if set and if specified in parameter fields.
CATEGORIES	Array<Integer>	The IDs of the categories assigned to this channel. Only returned if at least one category is set and if specified in parameter fields.

Examples

HM-CC-TC - Parent Device

(Struct length=10)
{
  [FAMILY]
  {
    (Integer) 0
  }
  [ID]
  {
    (Integer) 37
  }
  [ADDRESS]
  {
    (String) JEQ0550760
  }
  [CHILDREN]
  {
    (Array length=4)
    {
      (String) JEQ0550760:0
      (String) JEQ0550760:1
      (String) JEQ0550760:2
      (String) JEQ0550760:3
    }
  }
  [CHANNELS]
  {
    (Array length=4)
    {
      (Integer) 0
      (Integer) 1
      (Integer) 2
      (Integer) 3
    }
  }
  [FIRMWARE]
  {
    (String) 2.1
  }
  [FLAGS]
  {
    (Integer) 1
  }
  [PARAMSETS]
  {
    (Array length=1)
    {
      (String) MASTER
    }
  }
  [PARENT]
  {
    (String)
  }
  [RF_ADDRESS]
  {
    (String) 1936689
  }
  [TYPE]
  {
    (String) HM-CC-TC
  }
  [VERSION]
  {
    (Integer) 14
  }
}

HM-CC-TC - Channel 1

(Struct length=12)
{
  [FAMILY]
  {
    (Integer) 0
  }
  [ID]
  {
    (Integer) 37
  }
  [CHANNEL]
  {
    (Integer) 1
  }
  [ADDRESS]
  {
    (String) JEQ0550760:1
  }
  [AES_ACTIVE]
  {
    (Integer) 0
  }
  [DIRECTION]
  {
    (Integer) 1
  }
  [FLAGS]
  {
    (Integer) 1
  }
  [INDEX]
  {
    (Integer) 1
  }
  [LINK_SOURCE_ROLES]
  {
    (String) WEATHER_TH
  }
  [LINK_TARGET_ROLES]
  {
    (String)
  }
  [PARAMSETS]
  {
    (Array length=3)
    {
      (String) MASTER
      (String) VALUES
      (String) LINK
    }
  }
  [PARENT]
  {
    (String) JEQ0550760
  }
  [PARENT_TYPE]
  {
    (String) HM-CC-TC
  }
  [TYPE]
  {
    (String) WEATHER
  }
  [VERSION]
  {
    (Integer) 14
  }
}

DynamicResetTime

The struct DynamicResetTime defines how many seconds to wait before executing the reset method after an event was raised (in short: the "reset time"). This is useful for example when you want to increase the time light stays switched on with each motion detector event.

Enumerations Used in DynamicResetTime

Name	Values	Description
Operation	1	Addition
	2	Subtraction
	3	Multiplication
	4	Division

Members

Name	Type	Description
INITIALTIME	Integer	The initial reset time in seconds.
RESETAFTER	Integer	The time in seconds to wait before the reset time is reset to "INITIALTIME".
OPERATION	Operation	The mathematical operation to use on the current value of reset time.
FACTOR	Float	The factor to apply to the current reset time with the operation defined in "OPERATION".
LIMIT	Integer	The upper (addition, multiplication) or lower (subtraction, division) limit of the reset time (in seconds).
CURRENTTIME	Integer	Not writeable. Shows the current reset time in seconds when listing events.

Example: When "INITIALTIME" is 30, "FACTOR" is 2.0 and OPERATION is "Multiplication" then with the first event the reset time is 30, with the second 60, with the third 120 and so on until no event occurs for the time defined with "RESETAFTER".

When "LIMIT" is defined, the reset time will be capped at that limit. Let's say for the example above "LIMIT" is 300. Then the fourth event will increase the reset time to 240. The fifth event would increase the reset time to 480 which is greater than "LIMIT" so the reset time is set to 300.

Example

(Struct length=5)
{
  [INITIALTIME]
  {
    (Integer) 30
  }
  [RESETAFTER]
  {
    (Integer) 300
  }
  [OPERATION]
  {
    (Integer) 3
  }
  [FACTOR]
  {
    (Float) 2.0
  }
  [LIMIT]
  {
    (Integer) 300
  }
}

EventDescription

The struct EventDescription defines either a triggered or timed Homegear event.

Triggered events are checked when Homegear receives a packet from a device. They are raised e. g. when a device's parameter is changed.
Timed events can be triggered at a certain time point or recurrently (e. g. every two minutes).

Enumerations Used in EventDescription

Name	Values	Description
Type	0	Triggered
Type	1	Timed
Trigger	1	Unchanged: The parameter is unchanged compared to the previous value.
	2	Changed: The parameter has changed compared to the previous value.
	3	Greater: The parameter is now greater than the previous value.
	4	Less: The parameter is now smaller than the previous value.
	5	GreaterOrUnchanged: The parameter is now greater than the previous value or unchanged.
	6	LessOrUnchanged: The parameter is now smaller than the previous value or unchanged.
	7	Updated: The parameter was updated. This trigger is always true when a packet with the specified parameter is received. You have to use this trigger for parameters of type "Action".
	8	Value: The parameter value equals "TRIGGERVALUE".
	9	NotValue: The parameter does not equal "TRIGGERVALUE".
	10	GreaterThanValue: The parameter is greater than "TRIGGERVALUE".
	11	LessThanValue: The parameter is smaller than "TRIGGERVALUE".
	12	GreaterOrEqualValue: The parameter is greater than or equal "TRIGGERVALUE".
	13	LessOrEqualValue: The parameter is less than or equal "TRIGGERVALUE"

Members

EventDescription for Triggered Event

Name	Type	Description
TYPE	Type (Integer)	Type of the event ("timed" or "triggered")
ID	String	Arbitrary ID to identify the event
ENABLED	Boolean	Defines whether the event is enabled.
REPLACE	Boolean	If true an existing event with the same ID is replaced without RPC error.
PEERID	Integer	ID of the peer for which the event should be executed (e. g. 131). To create an event for system variable changes, leave it out or set it to "0", for metadata variable changes it needs to be set.
PEERCHANNEL	Integer	Optional. CHANNEL of the peer for which the event should be executed (e. g. 1). To create an event for system variable or metadata variable changes, leave it out or set it to "-1".
VARIABLE	String	The name of the device's variable to check (e. g. "STATE")
TRIGGER	Trigger (Integer)	Which trigger to use
TRIGGERVALUE	Variant	Only needed for triggers 8 to 13. The value to compare the parameter value to.
EVENTMETHOD	String	The name of the XML-RPC method to execute when event is raised.
EVENTMETHODPARAMS	Array<Variant>	The parameters to pass to "EVENTMETHOD".
RESETAFTER	Integer or DynamicResetTime	Optional. Time in seconds after which "RESETMETHOD" will be executed.
RESETMETHOD	String	Optional. Mandatory when "RESETAFTER" is specified. The XML-RPC method to execute after waiting the amount of seconds defined with "RESETAFTER".
RESETMETHODPARAMS	Array<Variant>	The parameters to pass to "RESETMETHOD".
LASTVALUE	Variant	Not writeable. The last value of "VARIABLE" received by the event handler.
LASTRAISED	Integer	Not writeable. Unix time stamp of the last time the event was raised.
LASTRESET	Integer	Not writeable. Unix time stamp of the last time the event was reset.

EventDescription for Timed Event

Name	Type	Description
TYPE	Type	Type of the event ("timed" or "triggered")
ID	String	Arbitrary ID to identify the event
ENABLED	Boolean	Defines whether the event is enabled.
REPLACE	Boolean	If true an existing event with the same ID is replaced without RPC error.
EVENTTIME	Integer	The unix timestamp of either a time point at which to execute a single event. Or the start time point of a recurrent event. Will be set to the current time when undefined or 0.
RECUREVERY	Integer	Optional. The time in seconds after which to recur the event (e. g. 120 (= 2 minutes) or 604800 (= 1 week).
ENDTIME	Integer	Optional. The time point when a recurrent event should be deleted.
EVENTMETHOD	String	The name of the XML-RPC method to execute when event is raised.
EVENTMETHODPARAMS	Array<Variant>	The parameters to pass to "EVENTMETHOD".

Examples

Example 1 - Triggered Event with Dynamic Reset Time

(Struct length=11)
{
  [TYPE]
  {
    (Integer) 0
  }
  [ID]
  {
    (String) MyThirdCustomEvent
  }
  [PEERID]
  {
    (Integer) 32
  }
  [PEERCHANNEL]
  {
    (Integer) 1
  }
  [VARIABLE]
  {
    (String) MOTION
  }
  [TRIGGER]
  {
    (Integer) 8
  }
  [TRIGGERVALUE]
  {
    (Boolean) 1
  }
  [EVENTMETHOD]
  {
    (String) setValue
  }
  [EVENTMETHODPARAMS]
  {
    (Array length=3)
    {
      (Integer) 12
      (Integer) 1
      (String) STATE
      (Boolean) 1
    }
  }
  [RESETAFTER]
  {
    (Struct length=5)
    {
      [INITIALTIME]
      {
        (Integer) 30
      }
      [RESETAFTER]
      {
        (Integer) 300
      }
      [OPERATION]
      {
        (Integer) 3
      }
      [FACTOR]
      {
        (Float) 2.0
      }
      [LIMIT]
      {
        (Integer) 300
      }
    }
  }
  [RESETMETHOD]
  {
    (String) setValue
  }
  [RESETMETHODPARAMS]
  {
    (Array length=3)
    {
      (Integer) 12
      (Integer) 1
      (String) STATE
      (Boolean) 0
    }
  }
}

Example 2 - Timed Event (Recurrent with End Time)

(Struct length=7)
{
  [TYPE]
  {
    (Integer) 1
  }
  [ID]
  {
    (String) MyFifthCustomEvent
  }
  [EVENTTIME]
  {
    (Integer) 1379941325
  }
  [RECUREVERY]
  {
    (Integer) 120
  }
  [ENDTIME]
  {
    (Integer) 1380027725
  }
  [EVENTMETHOD]
  {
    (String) runScript
  }
  [EVENTMETHODPARAMS]
  {
    (Array length=3)
    {
      (String) myScript.sh
      (Boolean) 0
    }
  }
}

InterfaceDescription

The struct InterfaceDescription describes a physical interface used by Homegear.

Members

Name	Type	Description
FAMILYID	Integer	The id of the device family the physical device communicates with.
ID	String	Unique identifier for this interface.
SERIALNUMBER	String	The serial number of the interface.
FIRMWAREVERSION	String	The firmware version of the interface.
CONNECTED	Boolean	State of the device. When "false" device is not working.
DEFAULT	Boolean	"True" when this interface is the default interface for this device family.
LASTPACKETRECEIVED	Integer	Unix time stamp of the last received packet.
LASTPACKETSENT	Integer	Unix time stamp of the last sent packet.
PHYSICALADDRESS	Integer	The physical address of the device.
TYPE	String	The type of the physical device.

Example

(Array length=2)
{
  (Struct length=7)
  {
    [ID]
    {
      (String) MyInterface
    }
    [CONNECTED]
    {
      (Boolean) 1
    }
    [DEFAULT]
    {
      (Boolean) 1
    }
    [FAMILYID]
    {
      (Integer) 0
    }
    [LASTPACKETRECEIVED]
    {
      (Integer) 1393069264
    }
    [LASTPACKETSENT]
    {
      (Integer) 1393069364
    }
    [PHYSICALADDRESS]
    {
      (Integer) 16581789
    }
    [TYPE]
    {
      (String) cc1100
    }
  }
  (Struct length=7)
  {
    [ID]
    {
      (String) MySecondInterface
    }
    [CONNECTED]
    {
      (Boolean) 1
    }
    [DEFAULT]
    {
      (Boolean) 1
    }
    [FAMILYID]
    {
      (Integer) 1
    }
    [LASTPACKETRECEIVED]
    {
      (Integer) 1393069243
    }
    [LASTPACKETSENT]
    {
      (Integer) 1393069243
    }
    [PHYSICALADDRESS]
    {
      (Integer) 1
    }
    [TYPE]
    {
      (String) rs485
    }
  }
}

LinkDescription

The struct LinkDescription describes a direct link between the channels of two devices (e. g. peer 12 channel 1 and peer 25 channel 3).

Special Types used in LinkDescription

Name	Values	Description
LinkFlags	1	Sender does not know receiver or is unknown
	2	Receiver does not know sender or is unknown
	4	Sender and receiver are two different channels of the same device. Used only when one of the channels is "virtual" and in combination with one of the broken flags.

Members

Name	Type	Description
SENDER_ID	Integer	The id of the sending device
SENDER_CHANNEL	Integer	The channel of the sending device
SENDER	String	For compatibility. The serial number and channel of the sending device separated by colon
RECEIVER_ID	Integer	The id of the receiving device
RECEIVER_CHANNEL	Integer	The channel of the receiving device
RECEIVER	String	For compatibility. The serial number and channel of the receiving device separated by colon
FLAGS	LinkFlags	or-linked LinkFlags
NAME	String	The name of the link as defined in addLink or setLinkInfo
SENDER_PARAMSET	Paramset	Optional (see getLinks). The link parameter set of the sending device.
RECEIVER_PARAMSET	Paramset	Optional (see getLinks). The link parameter set of the receiving device.
SENDER_DESCRIPTION	DeviceDescription	Optional (see getLinks). The device description of the sending channel.
RECEIVER_DESCRIPTION	DeviceDescription	Optional (see getLinks). The device description of the receiving channel.

ParameterDescription

The struct ParameterDescription describes one parameter of a parameter set.

Enumerations used in ParameterDescription

Name	Values	Description
Operations	1	Read
	2	Write
	4	Event (deprecated)
Flags	1	Visible: Parameter should be visible to the user
	2	Internal: Parameter is only used internally
	4	Transform: Changes to this parameter completely change the behavior of a channel. Changes are only allowed when the channel is not linked.
	8	Service: This parameter should be processed as service message. Only Boolean and Integer are allowed. 0 or false means there is no message.
	16	Sticky: Only for service messages. A sticky service message has to be manually reset by the user.

Structs used in ParameterDescription

Name	Description	Fields	Field Description
Special	Defines values with a special meaning outside the value range	ID	Name of the special value
Special		VALUE	The special value

Members

These are the possible values for TYPE.

Name	Type	Description
TYPE	String	Data type of the parameter
OPERATIONS	Operations	or-linked operations (Read: 1, Write: 2, Event: 3)
FLAGS	Flags	or-linked flags for the GUI
DEFAULT	Same as parameter	Default value
MAX	Same as parameter	Largest possible value
MIN	Same as parameter	Smallest possible value
UNIT	String	Unit of measurement
TAB_ORDER	Integer	Position of the parameter inside the parameter set
CONTROL	String	Optional. Tells the GUI which control to use for this parameter.
SPECIAL	Array of type Special	Only for types FLOAT and INTEGER. Defines special values outside the value range.
VALUE_LIST	Array of type String	Only for type ENUM. Defines names for the enumeration. The array index of the name is the associated value. If an array element is empty, the value is not defined.
LABEL	String	Optional. The human readable name of the parameter (e. g. "Setpoint temperature").
DESCRIPTION	String	Optional. A short description of the parameter (e. g. "Gets or sets the current setpoint temperature.")
FORM_FIELD_TYPE	String	Optional. The form field type to use in forms.
FORM_POSITION	Integer	Optional. The position of the parameter to use in forms.
ROOM	Integer	The ID of the room assigned to this variable. Only returned if set.
CATEGORIES	Array<Integer>	The IDs of the categories assigned to this variable. Only returned if at least one category is set.

Types

These are the possible values for TYPE.

Type	Description
FLOAT
INTEGER
BOOL
ENUM	Data type is Integer. The value as an index to one of the options defined in VALUE_LIST.
STRING
ACTION	Data type is Boolean. Always false when reading and always true in events. When writing, the value must be "true".

Example

(Struct length=10)
    {
      [DEFAULT]
      {
        (Integer) 0
      }
      [FLAGS]
      {
        (Integer) 1
      }
      [ID]
      {
        (String) LCD_SYMBOL
      }
      [MAX]
      {
        (Integer) 8
      }
      [MIN]
      {
        (Integer) 0
      }
      [OPERATIONS]
      {
        (Integer) 3
      }
      [TAB_ORDER]
      {
        (Integer) 2
      }
      [TYPE]
      {
        (String) ENUM
      }
      [UNIT]
      {
        (String)
      }
      [VALUE_LIST]
      {
        (Array length=9)
        {
          (String) NONE
          (String) BULB
          (String) SWITCH
          (String) WINDOW
          (String) DOOR
          (String) BLIND
          (String) SCENE
          (String) PHONE
          (String) BELL
        }
      }
    }

Paramset

The struct Paramset contains all values of a parameter set. One element is one value. The name of the element is the name of the parameter as defined in the XML file.

Example

(Struct length=350)
{
  [DISPLAY_TEMPERATUR_INFORMATION]
  {
    (Integer) 0
  }
  [DISPLAY_TEMPERATUR_UNIT]
  {
    (Integer) 0
  }
  [MODE_TEMPERATUR_REGULATOR]
  {
    (Integer) 0
  }
  [MODE_TEMPERATUR_VALVE]
  {
    (Integer) 0
  }
  [DISPLAY_TEMPERATUR_HUMIDITY_CHANGE]
  {
    (Integer) 1
  }
  [TEMPERATUR_COMFORT_VALUE]
  {
    (Float) 21
  }
  .
  .
  .
}

ParamsetDescription

The struct ParamsetDescription has one element for each parameter. The key is the parameter name. Each element is of type ParameterDescription.

Example

(Struct length=4)
{
  [PEER_NEEDS_BURST]
  {
    (Struct length=9)
    {
      [DEFAULT]
      {
        (Boolean) 0
      }
      [FLAGS]
      {
        (Integer) 1
      }
      [ID]
      {
        (String) PEER_NEEDS_BURST
      }
      [MAX]
      {
        (Boolean) 1
      }
      [MIN]
      {
        (Boolean) 0
      }
      [OPERATIONS]
      {
        (Integer) 3
      }
      [TAB_ORDER]
      {
        (Integer) 0
      }
      [TYPE]
      {
        (String) BOOL
      }
      [UNIT]
      {
        (String)
      }
    }
  }
  [EXPECT_AES]
  {
    (Struct length=9)
    {
      [DEFAULT]
      {
        (Boolean) 0
      }
      [FLAGS]
      {
        (Integer) 1
      }
      [ID]
      {
        (String) EXPECT_AES
      }
      [MAX]
      {
        (Boolean) 1
      }
      [MIN]
      {
        (Boolean) 0
      }
      [OPERATIONS]
      {
        (Integer) 3
      }
      [TAB_ORDER]
      {
        (Integer) 1
      }
      [TYPE]
      {
        (String) BOOL
      }
      [UNIT]
      {
        (String)
      }
    }
  }
  [LCD_SYMBOL]
  {
    (Struct length=10)
    {
      [DEFAULT]
      {
        (Integer) 0
      }
      [FLAGS]
      {
        (Integer) 1
      }
      [ID]
      {
        (String) LCD_SYMBOL
      }
      [MAX]
      {
        (Integer) 8
      }
      [MIN]
      {
        (Integer) 0
      }
      [OPERATIONS]
      {
        (Integer) 3
      }
      [TAB_ORDER]
      {
        (Integer) 2
      }
      [TYPE]
      {
        (String) ENUM
      }
      [UNIT]
      {
        (String)
      }
      [VALUE_LIST]
      {
        (Array length=9)
        {
          (String) NONE
          (String) BULB
          (String) SWITCH
          (String) WINDOW
          (String) DOOR
          (String) BLIND
          (String) SCENE
          (String) PHONE
          (String) BELL
        }
      }
    }
  }
  [LCD_LEVEL_INTERP]
  {
    (Struct length=10)
    {
      [DEFAULT]
      {
        (Integer) 0
      }
      [FLAGS]
      {
        (Integer) 1
      }
      [ID]
      {
        (String) LCD_LEVEL_INTERP
      }
      [MAX]
      {
        (Integer) 5
      }
      [MIN]
      {
        (Integer) 0
      }
      [OPERATIONS]
      {
        (Integer) 3
      }
      [TAB_ORDER]
      {
        (Integer) 3
      }
      [TYPE]
      {
        (String) ENUM
      }
      [UNIT]
      {
        (String)
      }
      [VALUE_LIST]
      {
        (Array length=6)
        {
          (String) NONE
          (String) LIGHT
          (String) BLIND
          (String) MARQUEE
          (String) DOOR
          (String) WINDOW
        }
      }
    }
  }
}

ServerInfo

The struct ServerInfo describes a RPC client's RPC server (event server).

Enumerations Used in ServerInfo

Name	Values	Description
AuthType	0	none
AuthType	1	basic

Members

Name	Type	Description
INTERFACE_ID	String	The interface ID as it was passed to init
HOSTNAME	String	The hostname or IP address of the RPC server used by Homegear. Might be different from the hostname/address passed to init.
PORT	String	The port of the RPC server
PATH	String	The path part of the URL (e. g. /RPC2).
LASTPACKETSENT	Integer	The time (unix time stamp) the last packet was sent successfully (no communication or RPC error) to the client's RPC server.
SSL	Boolean	"True" when "https" was passed to init
BINARY	Boolean	"True" when binary packets are used instead of XML-RPC
KEEP_ALIVE	Boolean	When "True", Homegear won't disconnect after receiving the response to a packet
USE_ID	Boolean	When "True", Homegear sends device's id instead of the serial number in broadcast packets
SUBSCRIBE_PEERS	Boolean	When "True", Homegear only sends events of peers subscribed with subscribePeers to the event server.

The following settings are defined in "rpcclients.conf".

Name	Type	Description
FORCESSL	Boolean	When "True", Homegear doesn't accept unencrypted connections from this client.
AUTH_TYPE	AuthType	The authentication type Homegear uses to connect to the RPC server.
VERIFICATION_HOSTNAME	String	When certificate verification is enabled, the hostname of the server certifacte has to match this hostname.
VERIFY_CERTIFICATE	Boolean	"True" when certificate verification is enabled

Example

(Array length=1)
{
  (Struct length=7)
  {
    [BINARY]
    {
      (Boolean) 0
    }
    [HOSTNAME]
    {
      (String) 127.0.0.1
    }
    [INTERFACE_ID]
    {
      (String) IPS
    }
    [KEEP_ALIVE]
    {
      (Boolean) 0
    }
    [LASTPACKETSENT]
    {
      (Integer) 1393069381
    }
    [PATH]
    {
      (String) /RPC2
    }
    [PORT]
    {
      (String) 5544
    }
    [SSL]
    {
      (Boolean) 0
    }
  }
}

Key	Type	Types	Optional	Description
`TYPE`	`Integer`		no	`0` for global, `1` for family and `2` for device service messages.
`PRIORITY`	`Integer`	`0`, `1`, `2`	no	`1`: critical, `2`: error, `3`: warning, `4`: info, `5`: debug
`TIMESTAMP`	`Integer`	`0`, `1`, `2`	no	The unix timestamp in seconds of the timepoint the service message was set.
`FAMILY_ID`	`Integer`	`1`	no	The ID of the family that created the service message.
`INTERFACE`	`String`	`1`	yes	When the service message is associated to a communication interface, the interface ID is set here.
`PEER_ID`	`Integer`	`2`	no	The ID of the peer that created the service message.
`CHANNEL`	`Integer`	`2`	no	The channel the service message is associated with.
`VARIABLE`	`String`	`2`	no	The variable the service message is associated with.
`MESSAGE_ID`	`Integer`	`0`, `1`	no	An message ID to identify the service message. The combination of `MESSAGE_ID` and `MESSAGE_SUBID` is unique.
`MESSAGE_SUBID`	`String`	`0`, `1`	no	A sub ID to indentify the service message. The combination of `MESSAGE_ID` and `MESSAGE_SUBID` is unique.
`MESSAGE`	`String`	`0`, `1`, `2`	no	The translated service message. If `language` is not specified, a Struct with all translations is returned. If a service message can be set multiple times (e. g. communication module service messages), a unique identifier is appended separated by a `.` (dot).
`DATA`	`Variant`	`0`, `1`	yes	Additional data associated with the service message.
`VALUE`	`Boolean`	`0`, `1`, `2`	no	The value of the service message.

Name	Type	Description	Example
filename	String	The name of the script file in the scripts directory. You can specify subdirectories of the scripts directory before the file name.	Subdir/MyScript.sh
wait	Boolean	If set to true waits for the script to finish. Otherwise the method returns immediately. Default is true.	true
arguments	String	The arguments to pass to the script.	-u -a

Name	Type	Description	Example
message	String	This is the message you want to write to the log file. The date is automatically prepended.	My message
logLevel	Integer	This is the log level of the message. If Homegear's log level value is lower than this value, no message is logged. Valid values are: 1: Critical 2: Error 3: Warning 4: Info 5: Debug	4

Name	Type	Description	Example
component	String	The name of the component to get values for as used in setData().	myaddon
key	String	The key as defined in setData(). If ommited all values for the component are returned.	mydata

Name	Type	Description	Example
component	String	The name of the component to store data for. Make sure it is unique. The maximum length are 250 characters.	myaddon
key	String	A name of your choice to access your data. The maximum length are 250 characters.	"mydata"
value	Variant	The value you want to store	43

Code	Description
-32602	component or key are longer than 250 characters.
-32500	The limit of 1 million data entries has been reached.

Name	Type	Description	Example
peerId	Integer	The ID of the actuator	131
channel	Integer	The channel of the actuator	1
remotePeerId	Integer	The ID of a peer linked to the actuator or "0" if you want to use a virtual peer	1
remoteChannel	Integer	The channel of a remote peer; use the same "channel" value if a virtual peer is specified.	1
address	String	The serial number and channel of the actuator separated by colon.	JEQ0578372:1
remoteAddress	String	The serial number and channel of a remote peer separated by colon.	LEQ0053372:1
longPress	Boolean	Set to "true" to simulate a long key press. The default setting is "false".	true

Code	Description
-2	Device or channel is unknown.
-3	Peers are not peered to each other.
-32400	Peer does not support this command.

Name	Type	Description	Example
senderId	Integer	The ID of the sending peer (e.g. a remote)	12
senderChannel	Integer	The channel of the sending peer or "-1"	1
receiverId	Integer	The ID of the receiving peer (e.g. a switch)	1
receiverChannel	Integer	The channel of the receiving peer or "-1"	1
senderAddress	String	The serial number and channel of the sending device (e.g. a remote), seperated by colon	JEQ0304693:7
receiverAddress	String	The serial number and channel of the receiving device (e.g. a switch), seperated by colon	JEQ0098488:1
name	String	A descriptive name for the link	Living Room - Light
description	String	A short description of the link	This is supposed to be a short description, but I have no idea what to write here...

Name	Type	Description	Example
sourcePeerId	Integer	The id of the peer to copy the parameter set from	131
sourceChannel	Integer	The channel to copy the parameter set from	3
targetPeerId	Integer	The id of the peer to copy the parameter set to	135
targetChannel	Integer	The channel to copy the parameter set to	2
sourceAddress	String	The serial number and channel of the device to copy the parameter set from (separated by colon)	JEQ0578372:1
targetAddress	String	The serial number and channel of the device to copy the parameter set to (separated by colon)	LEQ0053372:1

Code	Description
-2	Device or channel is unknown.
-3	At least one of the parameter sets is unknown.

Name	Type	Description	Example
peerId	Integer	The id of the peer to delete	51
address	String	The serial number of the device to delete	JEQ0578372
flags	Integer	The following flags are available: 1 (RESET): Resets the device to factory defaults (if possible). If this flag is not set the device is just unpaired without being reset. 2 (FORCE): Removes the device from Homegear. Homegear will try once to unpair or reset the device. If that fails the device is just removed from the central without any further attempts to unpair it. 4 (DEFER): Unpair the device when the next packet is received that can trigger unpairing. 8 (DELETE_FROM_GATEWAY): Also deletes the device from underlying gateway (if possible).	5 (RESET and DEFER)

Name	Type	Description	Example
peerId	Integer	When specified, only variables of this peer are returned.	12
peerIds	Array<Integer>	When specified, only variables of these peers are returned.	[ 10, 11, 12 ]
returnWriteOnlyVariables	Boolean	When specifed, writeOnly variables are also returned.	true

Name	Type	Description	Example
peerId	Integer	The ID of the peer to return the device description for.	12
channel	Integer	The channel of the peer to return the device description for.	1
address	String	The serialnumber and channel of the device seperated by colon.	JEQ0578372:1
fields	Array	When fields is not empty, only the struct elements defined in the array (e. g. ID or TYPE) are returned. This saves ressources. Some elements like DESCRIPTION or LONG_DESCRIPTION are only returned when explicitly requested through this variable.	[ "ID", "TYPE" ]

Name	Type	Description	Example
senderId	Integer	The ID of the sending peer (e. g. a remote).	12
senderChannel	Integer	The channel of the sending peer or "-1".	1
receiverId	Integer	The ID of the receiving peer (e. g. a switch).	14
receiverChannel	Integer	The channel of the receiving peer or "-1".	1
senderAddress	String	The serial number and channel of the sending peer separated by colon.	JEQ0578372:1
remoteAddress	String	The serial number and channel of the receiving peer separated by colon.	LEQ0053372:1

Name	Type	Description	Example
peerId	Integer	The ID of the peer to get links for.	12
channel	Integer	The channel to get the links for. If "-1" the links of all channels are returned.	1
address	String	The serial number and channel of the peer to get the links for. When no channel is specified, the function returns the peers for all channels.	JEQ0578372:1

Name	Type	Description	Example
peerId	Integer	The ID of the peer.	12
channel	Integer	The channel to get the configuration parameters for.	1
remotePeerId	Integer	An ID of a peer the peer is linked to. Used to return configuration parameters of a direct link between two peers.	14
remoteChannel	Integer	The channel of peer "remotePeerId" the peer is linked to.	1
address	String	The serial number and channel of the peer separated by colon.	JEQ0578372:1
paramsetType	String	"MASTER", "VALUES" or "LINK".	MASTER

Name	Type	Description	Example
peerId	Integer	The ID of the peer to get the value for.	131
channel	Integer	The channel of the peer to get the value for.	1
parameterName	Integer	The name of the variable as defined in the device's XML file.	1
requestFromDevice	Boolean	When set to true Homegear tries to read the value from the device instead of returning the cached value. This is not possible for all devices.	true
asynchronous	Boolean	Only relevant when requestFromDevice is true. When set to true the method returns immediately without waiting for the new value. The new value is sent as an event as soon as it is returned from the device.	true
address	string	The serial number and channel of the device to get the value for (separated by colon).	JEQ0123456:1

Name	Type	Description	Example
channels	Boolean	When set to "false", only the description of the device without the channel descriptions is returned. This saves a lot of ressources. For compatability reasons, "channels" only works when "fields" is set, too.	false
fields	Array<String>	When fields is not empty, only the DeviceDescription elements defined in the array ("ID", "PHYSICAL_ADDRESS", ...) are returned. This also saves ressources.	[ "ID", "FAMILY", "TYPE_ID" ]
familyId	Integer	If set only devices for this family are returned	4

Code	Description
-2	At least one of the devices or channels is unknown.
-6	The channels are not paired to each other.

RPC Method Reference

List of Functions

List of Event Server Functions

Overview

General

XML-RPC Types

Homegear-specific Types

DeviceDescription

Enumerations used in DeviceDescription

Members

DeviceDescription of Parent Device

DeviceDescription of Channel

Examples

HM-CC-TC - Parent Device

HM-CC-TC - Channel 1

DynamicResetTime

Enumerations Used in DynamicResetTime

Members

Example

EventDescription

Enumerations Used in EventDescription

Members

EventDescription for Triggered Event

EventDescription for Timed Event

Examples

Example 1 - Triggered Event with Dynamic Reset Time

Example 2 - Timed Event (Recurrent with End Time)

InterfaceDescription

Members

Example

LinkDescription

Special Types used in LinkDescription

Members

ParameterDescription

Enumerations used in ParameterDescription

Structs used in ParameterDescription

Members

Types

Example

Paramset

Example

ParamsetDescription

Example

ServerInfo

Enumerations Used in ServerInfo

Members

Example

Defined by XML-RPC Standard

system.getCapabilities

Signatures

Description

Parameters

Return Value

Example Output

system.listMethods

Signatures

Description

Parameters

Return Value

Example Output

system.methodHelp

Signatures

Description

Parameters

Return Value

Example Output

system.methodSignature

Signatures

Description

Parameters

Return Value

Errors

Example Output

system.multicall

Signatures

Description

Parameters

Return Value

Example Output

General

Name	Type	Description	Example
currentPeerId	Integer	The current ID of the peer	131
newPeerId	Integer	The new ID of the peer	79

Code	Description
-2	The device is unknown.
-100	Current or new peer ID are invalid.
-101	New peer ID is already in use.

Name	Type	Description	Example
peerId	Integer	The ID of the peer you want to set the name for	131
channel	Integer	The channel of the peer you want to set the name for (a channel of -1 sets the device's name). You can omit the channel when setting the name of the device.	1
name	String	The name to assign to the device	Living Room - Light

Name	Type	Description	Example
peerId	Integer	The id of the peer to add to the team.	131
channel	Integer	The channel of the peer to add to the team or "-1" if not applicable.	3
teamId	Integer	The id of a the team. If teamID is "0" or not set, the peer is removed from the team.	132
teamChannel	Integer	The channel of the team to add the peer to or "-1" if not applicable.	true
peerAddress	String	The serial number and channel of the peer to add to the team (separated by a colon)	JEQ0123457:1 or JEQ0123457
teamAddress	String	The serial number and channel of the team to add to the peer to (separated by a colon)	JEQ0123456:1 or JEQ0123456

Code	Description
-2	Peer/team or channel are unknown.
-6	The channel or device doesn't support teams or the channels are incompatible to each other.

Code	Description
-2	Peer or channel are unknown.
-5	Unknown parameter.
-6	Parameter is readonly.
-100	No answer from device.
-101	Device returned error.

Name	Type	Description	Example
id	String	The id of the event as defined by addEvent().	MyCustomEvent
enable	Boolean	true to enable and false to disable the event.	true

Name	Type	Description	Example
type	Integer	0 for triggered events or 1 for timed events. When specified listEvents returns only events of this event type.	0
peedId	Integer	The id of the peer to get events for.	131
channel	Integer	The channel of the peer to get events for or -1 to return the events for all channels.	2
variable	String	The name of a peer's parameter inside channel. When specified listEvents returns only events for this parameter.	STATE

Name	Type	Description	Example
interfaceId	String	This is an arbitrary name for the interface. To unregister an event server, pass an empty string to interfaceId.	MyTotallyAwesomeHomegearClient
flags	Integer	The following flags are available: 0x01: keepAlive: Do not close the connection after each packet. 0x02: binaryMode: Send RPC data in binary format. Equivalent to binary:// or binarys://. 0x04: newFormat: (Recommended) Send device's ID in broadcast methods instead of the serial number and activates variable types ARRAY and STRUCT. This is recommended because serial numbers are not necessarily unique. 0x08: subscribePeers: If this is set, Homegear will send events only for peers subscribed with subscribePeers() to the event server. 0x10: jsonMode: Send RPC data in JSON format. 0x20: dontSendNewDevices: Don't call listDevices() and newDevices() on client's event server after the call to init(). newDevices() is still being called when new devices are added. 0x80: reconnectInfinitely: Try to reconnect to client's event server even if it is unreachable. With this flag, the connection is never removed by Homegear - except it is restarted, it can only be removed by calling init() with empty interfaceId.	3
url	String	When URL is specified, Homegear opens a new connection to the specified RPC server. The must include a prefix (e. g. http://) and the port. If you use binary://, RPC data is sent in binary format. If you pass https:// or binarys://, SSL is enabled.	binarys://192.168.0.5:3344 or http://[fdef:3::1]:3344 or https://myeventserver:3344

Name	Type	Description	Example
eventServerId	String	This is either the url exactly as specified in "init" or the WebSocket client ID.	http://192.168.0.4:3344
peerIds	Array<Integer>	This is an integer array containing the peer IDs to be subscribed. There is no check to see whether a peer ID is valid.	(Array length=3) { (Integer) 13 (Integer) 22 (Integer) 31 }