CommonSense PHP API Library
Environment Class Reference

List of all members.

Public Member Functions

 Environment (stdClass $data, Api $api)
 getID ()
 getName ()
 getFloors ()
 getGpsOutline ()
 getPosition ()
 getDate ()
 update ($name)
 getSensors ()
 removeSensor ($sensorID)
 addSensors ($sensorIds)

Detailed Description

sense dashboard - Environment.php

This file is part of sense dashboard.

Author:
Remi Appels <remi@sense-os.nl> The class Environment handels all the environment actions

public

Author:
Remi Appels <remi@sense-os.nl>

Member Function Documentation

Environment::addSensors ( sensorIds)

The method adds a sensor to an environment. To connect an individual sensor a sensor object with only the sensor id can be given and to connect a list of sensors a sensors object with an array of sensor ids can be given.

public

Parameters:
ArraysensorIds
Returns:
mixed
Environment::Environment ( stdClass $  data,
Api api 
)

This method list the sensors which are connected to this environment.

public

Returns:
mixed
Environment::removeSensor ( sensorID)

This method removes the selected sensor from the selected environment.

public

Parameters:
intsensorID
Returns:
mixed
Environment::update ( name)

This method updates an environment. Only the fields that are send will be updated.

public

Parameters:
stringname
Returns:
mixed

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables