UPM API for Aeotec Smart Switch 6. More...

Detailed Description

ID: ss6
Name: Aeotec Smart Switch 6
Connection: uart
Category: wifi
Manufacturer: aeon
Link: http://aeotec.com/z-wave-plug-in-switch

This module allows for controlling and monitoring certain elements of an Aeotec Smart Switch 6.

    string defaultDev = "/dev/ttyACM0";
    // if an argument was specified, use it as the device instead
    if (argc > 1)
        defaultDev = string(argv[1]);
    // Instantiate an Aeotec SS6 instance, on device node 11.  You will
    // almost certainly need to change this to reflect your own network.
    // Use the ozwdump example to see what nodes are available.
    upm::AeotecSS6 sensor(11);
    // The first thing to do is create options, then lock them when done.
    sensor.optionsCreate();
    sensor.optionsLock();
    // Next, initialize it.
    cout << "Initializing, this may take awhile depending on your ZWave network" << endl;
    sensor.init(defaultDev);
    cout << "Initialization complete" << endl;
    // turn light on
    cout << "Turning switch on, then upm_delaying for 5 secs" << endl;
    sensor.on();
    upm_delay(5);
    cout << "Querying data..." << endl;
    while (shouldRun) {
        sensor.update();
        cout << "Switch status: " << sensor.isOn() << endl;
        cout << "Volts: " << sensor.getVolts() << " volts" << endl;
        cout << "Energy Consumption: " << sensor.getEnergy() << " kWh" << endl;
        cout << "Watts: " << sensor.getWatts() << endl;
        cout << "Current: " << sensor.getCurrent() << " amps" << endl;
        cout << endl;
        upm_delay(3);
    }
    cout << "Turning switch off and upm_delaying for 5 seconds..." << endl;
    sensor.off();
    upm_delay(5);
    cout << "Exiting..." << endl;

Public Types
enum	INDEX_VALUES_T : int { INDEX_SwitchCtrl = 0, INDEX_Energy_kWh = 4, INDEX_Power_Watts = 7, INDEX_Volts = 8, INDEX_Current = 9 }

Public Member Functions
	AeotecSS6 (int nodeID)

	~AeotecSS6 ()

void	on ()

void	off ()

bool	isOn ()

void	update ()

float	getEnergy ()

float	getWatts ()

float	getVolts ()

float	getCurrent ()

Public Member Functions inherited from ozwInterface
	ozwInterface (int nodeID)

virtual	~ozwInterface ()

virtual void	setDebug (bool enable)

virtual void	optionsCreate (std::string configPath="/etc/openzwave", std::string userConfigDir="", std::string cmdLine="")

virtual void	optionAddInt (std::string name, int val)

virtual void	optionAddBool (std::string name, bool val)

virtual void	optionAddString (std::string name, std::string val, bool append)

virtual void	optionsLock ()

virtual void	init (std::string devicePath, bool isHID=false)

virtual void	dumpNodes (bool all=false)

virtual std::string	getValueUnits (int index)

virtual std::string	getValueLabel (int index)

Additional Inherited Members
Protected Attributes inherited from ozwInterface
bool	m_debugging

uint32_t	m_nodeID

OZW *	m_instance

bool	m_initialized

Member Enumeration Documentation

enum INDEX_VALUES_T : int

These values correspond to the index values of the given node

Constructor & Destructor Documentation

AeotecSS6 ( int nodeID )

AeotecSS6 constructor

Parameters

nodeID The ZWave node number of the device we are interested in. Use the ozwdump example to see what nodes you have available.

~AeotecSS6 ( )

AeotecSS6 Destructor

Member Function Documentation

void on ( )

Turn the switch on.

Here is the call graph for this function:

void off ( )

Turn the switch off.

Here is the call graph for this function:

bool isOn ( )

Check to see if the switch is on or off.

Returns: true if the switch is on, false otherwise.

Here is the call graph for this function:

void update ( void )

Query the device and update internal state. Strictly speaking, this is not really neccessary – a device may send this data on it's own at periodic intervals. This method causes OZW to specifically query the device for it's current Energy, Watts, Volts, Current, and Switch status. The device may take some time to respond.

Here is the call graph for this function: