T2DModule Class Reference

IPS Module Helper Class combines often used functions and constants. More...

Inheritance diagram for T2DModule:

Public Member Functions
	__construct ($InstanceID, $json_file)
	Constructor.
	Create ()
	Create function.
	ApplyChanges ()
	Apply function.

Data Fields
const	IPS_KERNELMESSAGE = 10100
	IPS Message IDs.
const	KR_INIT = 10102
	Kernel Status "INIT".
const	KR_READY = 10103
	Kernel Status "Ready".
const	KR_UNINIT = 10104
	Kernel Status "UnInit".
const	ST_AKTIV = 102
	Module Status aktive.
const	ST_INACTIV = 104
	Module Status "inactive".
const	ST_ERROR = 201
	Module Status "Error".
const	ST_NOPARENT = 202
	Custom Module Status "NoParent".
const	VT_Boolean = 0
	IPS Variable Type Boolean.
const	VT_Integer = 1
	IPS Variable Type Integer.
const	VT_Float = 2
	IPS Variable Type Float.
const	VT_String = 3
	IPS Variable Type String.
const	IM_CHANGESTATUS =10505
	Instance Message Status change.
const	VM_DELETE =10602
	Variable Message Delete.
const	VM_UPDATE =10603
	Variable Message Update.

Protected Member Functions
	HasActiveParent ($id=0)
	Check if a parent is active.
	isActive ($id=0)
	Check if the given Instance is active.
	GetInstanceStatus ($id=0)
	Retrieve instance status.
	GetParent ($id=0)
	Check if a parent for Instance $id exists.
	GetCapList ()
	Get Property Caplist.
	GetCaps ()
	returns array of defined capabilities for this device Format:"cap:action;"
	GetActions ()
	returns array of defined Actions for this device
	CreateStatusVars ()
	create status variables out of capvar definitions from device
	SetStatusVariables ()
	remove variables not matching actual capabilities
	SwitchStatus ($val)
	parses switch status values to true/false
	SemEnter ($resource)
	Enter/Lock semaphore.
	SemLeave ($resource)
	Leave/unlock Semaphore.
	check_profile ($pname, $typ, $prefix, $suffix, $icon, $min, $max, $step, $digit=0, $drop=false)
	Check profile by name if exists, else create.
	drop_var ($ident)
	Delete a Variable by name if exists and assigned events.
	GetLocalBuffer ()
	Get status variable Buffer contains incoming data from IO, act as regVar.
	SetLocalBuffer ($val)
	Set status variable Buffer.
	debug ($topic, $data)
	Log an debug message PHP modules cannot enter data to debug window,use messages instead.
	isDebug ()
	check if debug is enabled
	debuglog ($data)
	Log Debug to its own file.

Protected Attributes
	$module_data = array()
	Vital module data build out of module.json.
	$DEBUGLOG = ''
	optional filename of a debug log (fully qualified)
	$name = ''
	Modul name for fast access.
	$capvars = array()
	Device capabilities to be overwrite in implementation.
	$actions = array()
	Device action capabilities to be overwrite in implementation.
	$module_interfaces
	often needed module GUIDs
	$useBufferVar =false
	Use StatusVariable as buffer (if Get/SetBuffer module functions are not available in IPS <4.1)

Detailed Description

IPS Module Helper Class combines often used functions and constants.

Constructor & Destructor Documentation

__construct()

__construct	(		$InstanceID,
			$json_file
	)

Constructor.

Parameters

integer	$InstanceID
string	$json_file	Path to module.json

Member Function Documentation

check_profile()

check_profile (   $pname,   $typ,   $prefix,   $suffix,   $icon,   $min,   $max,   $step,   $digit = 0,   $drop = false  )

protected

Check profile by name if exists, else create.

Parameters

String	$pname	Name
integer	$typ	Variable Typ (0..3)
String	$prefix	Prefix before value
String	$suffix	Suffix after value
String	$icon	Icon Name
integer	$min	min value
integer	$max	max value
integer	$step	step value
integer	$digit	digits for formatting
boolean	$drop	drop existing profile first

debug()

debug (   $topic,   $data  )

protected

Log an debug message PHP modules cannot enter data to debug window,use messages instead.

Parameters

$topic
$data

debuglog()

debuglog (   $data )

protected

Log Debug to its own file.

Parameters

$data

drop_var()

drop_var (   $ident )

protected

Delete a Variable by name if exists and assigned events.

Parameters

String

$ident

GetActions()

GetActions ( )

protected

returns array of defined Actions for this device

Returns

array

GetCapList()

GetCapList ( )

protected

Get Property Caplist.

Returns

string

GetCaps()

GetCaps ( )

protected

returns array of defined capabilities for this device Format:"cap:action;"

Returns

array

GetInstanceStatus()

GetInstanceStatus (   $id = 0 )

protected

Retrieve instance status.

Parameters

int

$id

Returns

mixed

GetLocalBuffer()

GetLocalBuffer ( )

protected

Get status variable Buffer contains incoming data from IO, act as regVar.

Returns

String

GetParent()

GetParent (   $id = 0 )

protected

Check if a parent for Instance $id exists.

Parameters

$id	integer InstanceID

Returns

integer

HasActiveParent()

HasActiveParent (   $id = 0 )

protected

Check if a parent is active.

Parameters

$id	integer InstanceID

Returns

bool

isActive()

isActive (   $id = 0 )

protected

Check if the given Instance is active.

Parameters

int

$id

Returns

bool

isDebug()

isDebug ( )

protected

check if debug is enabled

Returns

bool

SemEnter()

SemEnter (   $resource )

protected

Enter/Lock semaphore.

Parameters

$resource

Returns

bool

SemLeave()

SemLeave (   $resource )

protected

Leave/unlock Semaphore.

Parameters

$resource

SetLocalBuffer()

SetLocalBuffer (   $val )

protected

Set status variable Buffer.

Parameters

String

$val

SwitchStatus()

SwitchStatus (   $val )

protected

parses switch status values to true/false

Parameters

bool | mixed

$val

Returns

bool

Field Documentation

IPS_KERNELMESSAGE

const IPS_KERNELMESSAGE = 10100

IPS Message IDs.

See also

https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/nachrichten/ Kernel Message ID

---

The documentation for this class was generated from the following file:

• C:/local/progs/ipsymcon/phpmodule/ipsymcon-phpmodule-by-Tommi/libs/module_helper.php