Custom Drivers Command and Utility Methods API

From HSYCO
Revision as of 10:25, 19 February 2014 by Hsyco (talk | contribs) (Created page with "== Constants == === LIGHT === LIGHT === AUTOM === AUTOM === DIMMER === DIMMER === BINARY === BINARY == System Functions == === dateSet === boolean dateSet(int year,...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Constants

LIGHT

LIGHT

AUTOM

AUTOM

DIMMER

DIMMER

BINARY

BINARY

System Functions

dateSet

boolean dateSet(int year, int month, int day, int hour, int minute, int second)

getNextSunrise

long getNextSunrise(long now, boolean withoffset)

getNextSunset

long getNextSunset(long now, boolean withoffset)

haActiveState

boolean haActiveState()

sleep

void sleep(long millis)

varGet

String varGet(String name)

varSet

void varSet(String name, String value)

Driver Control

init

boolean init(String name)

commandPoll

String commandPoll(int millis)

Driver I/O

ioSet

void ioSet(String name, String value)

ioWrite

void ioWrite(String name, String value)

ioWriteNoLog

void ioWriteNoLog(String name, String value)

ioWriteNoEvents

void ioWriteNoEvents(String name, String value)

ioWriteNoEventsNoLog

void ioWriteNoEventsNoLog(String name, String value)

ioWriteForced

void ioWriteForced(String name, String value)

ioWriteForcedNoLog

void ioWriteForcedNoLog(String name, String value)

Log

errorLog

void errorLog(String message)

fileLog

void fileLog(String pathname, String message)

messageLog

void messageLog(String message)

Mail

sendMail

int sendMail(String to, String from, String subject, String body)

sendMail

int sendMail(String to, String from, String subject, Vector<String> body)

Public Announcement

audioPlay

int audioPlay(String where, File file)

audioPlay

int audioPlay(String where, String voice, String text)

Serial Communication Ports

closeComm

void closeComm(String portName)

readComm

String readComm(String portName, int len)

readCommBytes

byte[] readCommBytes(String portName, int len)

writeComm

int writeComm(String portName, String data)

writeCommBytes

int writeCommBytes(String portName, byte[] data)

User Interface

deviceSet

void deviceSet(int function, String device, String state, String comment)

enableSystemtopoDiscovery

void enableSystemtopoDiscovery()

uiClear

void uiClear(String session)

uiSet

void uiSet(String session, String id, String attr, String value)

uiSet

void uiSet(String id, String attr, String value)

user

void user(String name, String param)