API Documentation
\

\jeedom

Summary

Methods
Properties
Constants
mimify()
getThemeConfig()
addTimelineEvent()
getTimelineEvent()
removeTimelineEvent()
addRemoveHistory()
deadCmd()
health()
sick()
getApiKey()
apiModeResult()
apiAccess()
isOk()
getUsbMapping()
getBluetoothMapping()
consistency()
backup()
listBackup()
removeBackup()
restore()
update()
getConfiguration()
version()
stop()
start()
isStarted()
isDateOk()
event()
cron5()
cron10()
cron()
cronDaily()
cronHourly()
replaceTag()
checkOngoingThread()
retrievePidThread()
versionAlias()
toHumanReadable()
fromHumanReadable()
evaluateExpression()
calculStat()
getTypeUse()
haltSystem()
rebootSystem()
forceSyncHour()
cleanDatabase()
cleanFileSytemRight()
checkSpaceLeft()
getTmpFolder()
getHardwareKey()
getHardwareName()
isCapable()
benchmark()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
checkValueInconfiguration()
$jeedomConfiguration
N/A

Properties

$jeedomConfiguration

$jeedomConfiguration :

Type

Methods

mimify()

mimify()

getThemeConfig()

getThemeConfig()

addTimelineEvent()

addTimelineEvent(  $_event)

Parameters

$_event

getTimelineEvent()

getTimelineEvent()

removeTimelineEvent()

removeTimelineEvent()

addRemoveHistory()

addRemoveHistory(  $_data)

Parameters

$_data

deadCmd()

deadCmd()

health()

health()

sick()

sick()

getApiKey()

getApiKey(  $_plugin = 'core')

Parameters

$_plugin

apiModeResult()

apiModeResult(  $_mode = 'enable')

Parameters

$_mode

apiAccess()

apiAccess(  $_apikey = '',   $_plugin = 'core')

Parameters

$_apikey
$_plugin

isOk()

isOk()

getUsbMapping()

getUsbMapping(  $_name = '',   $_getGPIO = false)

Parameters

$_name
$_getGPIO

getBluetoothMapping()

getBluetoothMapping(  $_name = '')

Parameters

$_name

consistency()

consistency()

backup()

backup(  $_background = false)

Parameters

$_background

listBackup()

listBackup()

removeBackup()

removeBackup(  $_backup)

Parameters

$_backup

restore()

restore(  $_backup = '',   $_background = false)

Parameters

$_backup
$_background

update()

update(  $_options = array())

Parameters

$_options

getConfiguration()

getConfiguration(  $_key = '',   $_default = false)

Parameters

$_key
$_default

version()

version()

stop()

stop()

start()

start()

isStarted()

isStarted()

isDateOk()

isDateOk() : boolean

Returns

boolean

event()

event(  $_event,   $_forceSyncMode = false)

Parameters

$_event
$_forceSyncMode

cron5()

cron5()

cron10()

cron10()

cron()

cron()

cronDaily()

cronDaily()

cronHourly()

cronHourly()

replaceTag()

replaceTag(array  $_replaces)

Parameters

array $_replaces

checkOngoingThread()

checkOngoingThread(  $_cmd)

Parameters

$_cmd

retrievePidThread()

retrievePidThread(  $_cmd)

Parameters

$_cmd

versionAlias()

versionAlias(  $_version,   $_lightMode = true)

Parameters

$_version
$_lightMode

toHumanReadable()

toHumanReadable(  $_input)

Parameters

$_input

fromHumanReadable()

fromHumanReadable(  $_input)

Parameters

$_input

evaluateExpression()

evaluateExpression(  $_input,   $_scenario = null)

Parameters

$_input
$_scenario

calculStat()

calculStat(  $_calcul,   $_values)

Parameters

$_calcul
$_values

getTypeUse()

getTypeUse(  $_string = '')

Parameters

$_string

haltSystem()

haltSystem()

rebootSystem()

rebootSystem()

forceSyncHour()

forceSyncHour()

cleanDatabase()

cleanDatabase()

cleanFileSytemRight()

cleanFileSytemRight()

checkSpaceLeft()

checkSpaceLeft(  $_dir = null)

Parameters

$_dir

getTmpFolder()

getTmpFolder(  $_plugin = null)

Parameters

$_plugin

getHardwareKey()

getHardwareKey()

getHardwareName()

getHardwareName()

isCapable()

isCapable(  $_function,   $_forceRefresh = false)

Parameters

$_function
$_forceRefresh

benchmark()

benchmark()

checkValueInconfiguration()

checkValueInconfiguration(  $_key,   $_value)

Parameters

$_key
$_value