#import "stl.h"
Typedefs | |
typedef unsigned long | xsd__unsignedInt |
typedef unsigned long long | xsd__unsignedLong |
Functions | |
int | Authenticate (char *_userName, char *_password, std::string &token) |
Authenticates your ip to the system. | |
int | SignOff (char *_token, int &result) |
Terminates a session. | |
int | ApartmentCreateSetFromGroup (char *_token, char *_groupName, std::string &result) |
Creates a set containing all devices which are contained in a group named _groupName. | |
int | ApartmentCreateSetFromDeviceIDs (char *_token, std::vector< std::string > _ids, std::string &result) |
Creates a set containing all devices in the given array. | |
int | ApartmentCreateSetFromDeviceNames (char *_token, std::vector< std::string > _names, std::string &result) |
Creates a set containing all devices in the given array. | |
int | ApartmentGetDevices (char *_token, std::string &result) |
Creates a set containing all devices. | |
int | ApartmentGetDeviceIDByName (char *_token, char *_deviceName, std::string &deviceID) |
Returns the device ID for the given _deviceName. | |
int | ApartmentGetName (char *_token, std::string &result) |
int | ApartmentSetName (char *_token, char *_name, bool &result) |
int | SetAddDeviceByName (char *_token, char *_setSpec, char *_name, std::string &result) |
Adds the given device to the set. | |
int | SetAddDeviceByID (char *_token, char *_setSpec, char *_deviceID, std::string &result) |
Adds the given device to the set. | |
int | SetRemoveDevice (char *_token, char *_setSpec, char *_deviceID, std::string &result) |
Removes the device from the set. | |
int | SetCombine (char *_token, char *_setSpec1, char *_setSpec2, std::string &result) |
Combines two sets into another set. | |
int | SetRemove (char *_token, char *_setSpec, char *_setSpecToRemove, std::string &result) |
Removes all devices contained in _SetIDToRemove from _setID and copies those into setID. | |
int | SetByGroup (char *_token, char *_setSpec, int _groupID, std::string &result) |
Removes all devices which don't belong to the specified group. | |
int | SetGetContainedDevices (char *_token, char *_setSpec, std::vector< std::string > &deviceIDs) |
Returns an array containing all device ids contained in the given set. | |
int | ApartmentGetGroupByName (char *_token, char *_groupName, int &groupID) |
Looks up the group id for the given group name. | |
int | ApartmentGetZoneByName (char *_token, char *_zoneName, int &zoneID) |
Looks up the zone id for the given zone. | |
int | ApartmentGetZoneIDs (char *_token, std::vector< int > &zoneIDs) |
Returns an array containing all zone ids. | |
int | SetTurnOn (char *_token, char *_setSpec, bool &result) |
Sends a turn on command to all devices contained in the set. | |
int | SetTurnOff (char *_token, char *_setSpec, bool &result) |
Sends a turn off command to all devices contained in the set. | |
int | SetIncreaseValue (char *_token, char *_setSpec, bool &result) |
Increases the main value (e.g. | |
int | SetDecreaseValue (char *_token, char *_setSpec, bool &result) |
Decreases the main value (e.g. | |
int | SetSetValue (char *_token, char *_setSpec, unsigned char _value, bool &result) |
Sets the parameter specified by _paramID to _value. | |
int | SetCallScene (char *_token, char *_setSpec, int _sceneNr, bool &result) |
Calls the scene _sceneNr on all devices contained int the set _setID. | |
int | SetSaveScene (char *_token, char *_setSpec, int _sceneNr, bool &result) |
Saves the scene _sceneNr on all devices contained int the set _setID. | |
int | ApartmentTurnOn (char *_token, int _groupID, bool &result) |
Sends a turn on command to all devices contained in the group. | |
int | ApartmentTurnOff (char *_token, int _groupID, bool &result) |
Sends a turn off command to all devices contained in the group. | |
int | ApartmentIncreaseValue (char *_token, int _groupID, bool &result) |
Increases the main value (e.g. | |
int | ApartmentDecreaseValue (char *_token, int _groupID, bool &result) |
Decreases the main value (e.g. | |
int | ApartmentSetValue (char *_token, int _groupID, unsigned char _value, bool &result) |
Sets the parameter specified by _paramID to _value. | |
int | ApartmentCallScene (char *_token, int _groupID, int _sceneNr, bool &result) |
Calls the scene _sceneNr on all devices contained int the group _groupID. | |
int | ApartmentSaveScene (char *_token, int _groupID, int _sceneNr, bool &result) |
Saves the scene _sceneNr on all devices contained int the group _groupID. | |
int | ApartmentRescan (char *_token, bool &result) |
Rescans the bus for new devices/circuits. | |
int | CircuitRescan (char *_token, char *_dsid, bool &result) |
Rescans the circuit for new/lost devices. | |
int | ZoneTurnOn (char *_token, int _zoneID, int _groupID, bool &result) |
Sends a turn on command to all devices contained in the zone/group. | |
int | ZoneTurnOff (char *_token, int _zoneID, int _groupID, bool &result) |
Sends a turn off command to all devices contained in the group. | |
int | ZoneIncreaseValue (char *_token, int _zoneID, int _groupID, bool &result) |
Increases the main value (e.g. | |
int | ZoneDecreaseValue (char *_token, int _zoneID, int _groupID, bool &result) |
Decreases the main value (e.g. | |
int | ZoneSetValue (char *_token, int _zoneID, int _groupID, unsigned char _value, bool &result) |
Sets the parameter specified by _paramID to _value. | |
int | ZoneCallScene (char *_token, int _zoneID, int _groupID, int _sceneNr, bool &result) |
Calls the scene _sceneNr on all devices contained int the zone/group _groupID. | |
int | ZoneSaveScene (char *_token, int _zoneID, int _groupID, int _sceneNr, bool &result) |
Saves the scene _sceneNr on all devices contained int the zone/group _groupID. | |
int | DeviceTurnOn (char *_token, char *_deviceID, bool &result) |
Sends a turn on command to the device. | |
int | DeviceTurnOff (char *_token, char *_deviceID, bool &result) |
Sends a turn off command to the device. | |
int | DeviceIncreaseValue (char *_token, char *_deviceID, bool &result) |
Increases the main value (e.g. | |
int | DeviceDecreaseValue (char *_token, char *_deviceID, bool &result) |
Decreases the main value (e.g. | |
int | DeviceSetValue (char *_token, char *_deviceID, unsigned char _value, bool &result) |
Set main value (e.g. | |
int | DeviceSetConfig (char *_token, char *_deviceID, unsigned char _configClass, unsigned char _configIndex, unsigned char _value, bool &result) |
Sets the configuration value of the given config class and config index. | |
int | DeviceGetConfig (char *_token, char *_deviceID, unsigned char _configClass, unsigned char _configIndex, unsigned char &result) |
Returns configuration value of the given config class and config index. | |
int | DeviceGetConfigWord (char *_token, char *_deviceID, unsigned char _configClass, unsigned char _configIndex, unsigned short int &result) |
Returns configuration value of the given config class and config index. | |
int | DeviceCallScene (char *_token, char *_deviceID, int _sceneNr, bool &result) |
Calls the scene _sceneNr on the device identified by _deviceID. | |
int | DeviceSaveScene (char *_token, char *_deviceID, int _sceneNr, bool &result) |
Saves the scene _sceneNr on the device identified by _devicdID. | |
int | DeviceGetName (char *_token, char *_deviceID, char **result) |
Returns the name of a device. | |
int | DeviceSetName (char *_token, char *_deviceID, char *_name, bool &result) |
Sets the name of a device. | |
int | DeviceGetZoneID (char *_token, char *_deviceID, int &result) |
Returns the zone id of the specified device. | |
int | DeviceAddTag (char *_token, char *_deviceID, char *_tag, bool &result) |
int | DeviceRemoveTag (char *_token, char *_deviceID, char *_tag, bool &result) |
int | DeviceHasTag (char *_token, char *_deviceID, char *_tag, bool &result) |
int | DeviceGetTags (char *_token, char *_deviceID, std::vector< std::string > &result) |
int | DeviceLock (char *_token, char *_deviceID, bool &result) |
int | DeviceUnlock (char *_token, char *_deviceID, bool &result) |
int | DeviceGetIsLocked (char *_token, char *_deviceID, bool &result) |
int | DSMeterGetPowerConsumption (char *_token, char *_dsMeterID, xsd__unsignedInt &result) |
int | ApartmentGetDSMeterIDs (char *_token, std::vector< std::string > &ids) |
Returns an integer array of dsMeters known to the dss. | |
int | DSMeterGetName (char *_token, char *_dsMeterID, std::string &name) |
Retuns the name of the given dsMeter. | |
int | DSMeterSetName (char *_token, char *_dsMeterID, char *_name, bool &result) |
Sets the name of the given dsMeter. | |
int | ApartmentAllocateZone (char *_token, int &zoneID) |
Allocates a zone. | |
int | ApartmentDeleteZone (char *_token, int _zoneID, int &result) |
Deletes a previously allocated zone. | |
int | ZoneSetName (char *_token, int _zoneID, char *_name, bool &result) |
Sets the name of a zone to _name. | |
int | ZoneGetName (char *_token, int _zoneID, std::string &result) |
Returns the name of a zone. | |
int | GroupSetName (char *_token, int _zoneID, int _groupID, char *_name, bool &result) |
int | GroupGetName (char *_token, int _zoneID, int _groupID, std::string &result) |
int | DeviceGetFunctionID (char *_token, char *_deviceID, int &result) |
Returns the function id of the specified device. | |
int | EventRaise (char *_token, char *_eventName, char *_context, char *_parameter, char *_location, bool &result) |
int | EventWaitFor (char *_token, int _timeout, std::vector< Event > &result) |
int | EventSubscribeTo (char *_token, std::string _name, std::string &result) |
int | PropertyGetType (char *_token, std::string _propertyName, std::string &result) |
int | PropertySetInt (char *_token, std::string _propertyName, int _value, bool _mayCreate=true, bool &result) |
int | PropertySetString (char *_token, std::string _propertyName, char *_value, bool _mayCreate=true, bool &result) |
int | PropertySetBool (char *_token, std::string _propertyName, bool _value, bool _mayCreate=true, bool &result) |
int | PropertyGetInt (char *_token, std::string _propertyName, int &result) |
int | PropertyGetString (char *_token, std::string _propertyName, std::string &result) |
int | PropertyGetBool (char *_token, std::string _propertyName, bool &result) |
int | PropertyGetChildren (char *_token, std::string _propertyName, std::vector< std::string > &result) |
int | StructureAddDeviceToZone (char *_token, char *_deviceID, int _zoneID, bool &result) |
int ApartmentCallScene | ( | char * | _token, | |
int | _groupID, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Calls the scene _sceneNr on all devices contained int the group _groupID.
int ApartmentCreateSetFromDeviceIDs | ( | char * | _token, | |
std::vector< std::string > | _ids, | |||
std::string & | result | |||
) |
Creates a set containing all devices in the given array.
int ApartmentCreateSetFromGroup | ( | char * | _token, | |
char * | _groupName, | |||
std::string & | result | |||
) |
Creates a set containing all devices which are contained in a group named _groupName.
int ApartmentDecreaseValue | ( | char * | _token, | |
int | _groupID, | |||
bool & | result | |||
) |
Decreases the main value (e.g.
brightness) for each device contained in the group.
int ApartmentDeleteZone | ( | char * | _token, | |
int | _zoneID, | |||
int & | result | |||
) |
Deletes a previously allocated zone.
int ApartmentGetDSMeterIDs | ( | char * | _token, | |
std::vector< std::string > & | ids | |||
) |
Returns an integer array of dsMeters known to the dss.
int ApartmentIncreaseValue | ( | char * | _token, | |
int | _groupID, | |||
bool & | result | |||
) |
Increases the main value (e.g.
brightness) for each device contained in the group.
int ApartmentSaveScene | ( | char * | _token, | |
int | _groupID, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Saves the scene _sceneNr on all devices contained int the group _groupID.
int ApartmentSetValue | ( | char * | _token, | |
int | _groupID, | |||
unsigned char | _value, | |||
bool & | result | |||
) |
Sets the parameter specified by _paramID to _value.
If _paramID == -1 the default parameter will be set.
int Authenticate | ( | char * | _userName, | |
char * | _password, | |||
std::string & | token | |||
) |
Authenticates your ip to the system.
The token received will be used in any subsequent call. The ip/token pair identifies a session. A Session will time out after n minutes of no activity (default 5).
int DeviceCallScene | ( | char * | _token, | |
char * | _deviceID, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Calls the scene _sceneNr on the device identified by _deviceID.
int DeviceDecreaseValue | ( | char * | _token, | |
char * | _deviceID, | |||
bool & | result | |||
) |
Decreases the main value (e.g.
brightness) on the device.
int DeviceIncreaseValue | ( | char * | _token, | |
char * | _deviceID, | |||
bool & | result | |||
) |
Increases the main value (e.g.
brightness) on the device.
int DeviceSaveScene | ( | char * | _token, | |
char * | _deviceID, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Saves the scene _sceneNr on the device identified by _devicdID.
int DeviceSetValue | ( | char * | _token, | |
char * | _deviceID, | |||
unsigned char | _value, | |||
bool & | result | |||
) |
Set main value (e.g.
brightness) on the device.
int DeviceTurnOff | ( | char * | _token, | |
char * | _deviceID, | |||
bool & | result | |||
) |
Sends a turn off command to the device.
int DeviceTurnOn | ( | char * | _token, | |
char * | _deviceID, | |||
bool & | result | |||
) |
Sends a turn on command to the device.
int DSMeterGetName | ( | char * | _token, | |
char * | _dsMeterID, | |||
std::string & | name | |||
) |
Retuns the name of the given dsMeter.
int DSMeterSetName | ( | char * | _token, | |
char * | _dsMeterID, | |||
char * | _name, | |||
bool & | result | |||
) |
Sets the name of the given dsMeter.
int SetCallScene | ( | char * | _token, | |
char * | _setSpec, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Calls the scene _sceneNr on all devices contained int the set _setID.
int SetDecreaseValue | ( | char * | _token, | |
char * | _setSpec, | |||
bool & | result | |||
) |
Decreases the main value (e.g.
brightness) for each device contained in the set.
int SetIncreaseValue | ( | char * | _token, | |
char * | _setSpec, | |||
bool & | result | |||
) |
Increases the main value (e.g.
brightness) for each device contained in the set.
int SetSaveScene | ( | char * | _token, | |
char * | _setSpec, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Saves the scene _sceneNr on all devices contained int the set _setID.
int SetSetValue | ( | char * | _token, | |
char * | _setSpec, | |||
unsigned char | _value, | |||
bool & | result | |||
) |
Sets the parameter specified by _paramID to _value.
If _paramID == -1 the default parameter will be set.
int SignOff | ( | char * | _token, | |
int & | result | |||
) |
Terminates a session.
All resources allocate by the session will be released.
int ZoneCallScene | ( | char * | _token, | |
int | _zoneID, | |||
int | _groupID, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Calls the scene _sceneNr on all devices contained int the zone/group _groupID.
int ZoneDecreaseValue | ( | char * | _token, | |
int | _zoneID, | |||
int | _groupID, | |||
bool & | result | |||
) |
Decreases the main value (e.g.
brightness) for each device contained in the zone/group.
int ZoneIncreaseValue | ( | char * | _token, | |
int | _zoneID, | |||
int | _groupID, | |||
bool & | result | |||
) |
Increases the main value (e.g.
brightness) for each device contained in the zone/group.
int ZoneSaveScene | ( | char * | _token, | |
int | _zoneID, | |||
int | _groupID, | |||
int | _sceneNr, | |||
bool & | result | |||
) |
Saves the scene _sceneNr on all devices contained int the zone/group _groupID.
int ZoneSetValue | ( | char * | _token, | |
int | _zoneID, | |||
int | _groupID, | |||
unsigned char | _value, | |||
bool & | result | |||
) |
Sets the parameter specified by _paramID to _value.
If _paramID == -1 the default parameter will be set.