Application Programmer Interfaces (APIs)

pmdctl

Abstract

Application Programming Interface (API) for the DssW Power Manager Scheduler.

Discussion

This interface is the primary interface API for the Scheduler. All changes to the Scheduler must pass through this API. Do not change underlying files or data directly.

Objects

Client

Host device details.

Time Zone

Local time zone details

Power

Power source details.

Authorisation

Authorisation control for requests and functionality.

Astronomic

Astronomical calculator.

Audio

Device audio settings.

Event Store

Stores, organises, and tracks events.

Scheduler

Coordinates the events, triggers, conditions, and actions.

On Demand

On demand events can be performed immediately.

Notifications

All pending events and their notifications.

Build

Scheduler meta-data.

Legal

Legal and licensing details.

Listen

Configures and controls incoming network connections.

Client

Time Zone

Power

Authorisation

Astronomic

Audio

Event Store

Scheduler

On Demand

Notifications

Build

Legal

Listen

client.localhostname

client.ethernetaddress

client.ethernetaddresses

client.machinemodel

timezone.name

timezone.utcoffset

power.sources

authorisation.rights

authorisation.applyright

astronomic.sunobservation

audio.systemmastervolume

audio.systemmute

audio.volume

audio.mute

audio.setsystemmastervolume

audio.setsystemmute

audio.setvolume

audio.setmute

eventstore.events

eventstore.store

eventstore.remove

eventstore.history

scheduler.enabled

scheduler.pending

scheduler.active

scheduler.setenabled

scheduler.cancel

scheduler.adjust

scheduler.reset

ondemand.available

ondemand.perform

notifications.current

notifications.warning

notifications.warningperiod

notifications.notifyperiod

notifications.setwarningperiod

notifications.setnotifyperiod

build.version

build.revision

build.restart

legal.licence

legal.license

legal.revoke

listen.sockets

listen.applysocket

listen.removesocket

environment variable

resource limits

external

external executable

external inline

sample criterion

sample criterion equal

sample criterion not equal

external criterion

external criterion interpret

external criterion contains

sample

sample execute external

application description

power source

power source serial

power source USB

power source network

power source internal

power source unknown

power source filter

geolocation

notification context value

process signature

process signature bundle identifier

process signature name

process signature localised name

trigger

trigger once

trigger daily

trigger after inactivity

trigger notification

trigger power on

trigger start up

trigger log in

trigger log out

trigger user session time

trigger sleep

trigger sample

trigger power state

trigger power remaining

trigger battery health

trigger sun

trigger external assistant

trigger application

trigger audio mute

trigger audio volume

condition

condition boolean

condition delayed boolean

condition days

condition date range

condition time range

condition execute external

condition sample

condition running processes

condition power assertions

condition power state

condition battery health

condition power remaining

condition sun

condition user inactivity

condition console user

condition start up

condition audio mute

condition audio volume

criteria

action

action sleep

action shut down

action restart

action log out

action fast user switch

action notification

action execute external

action launch application

action warn

action await once

action await daily

action await relative date

action await user inactivity

action await notification

action await power on

action await start up

action await sleep

action await sample

action await log in

action await log out

action await user session time

action await battery health

action await power state

action await power remaining

action await sun

action await external assistant

action await application

action audio volume

action audio mute

event

queued trigger

queued warning

event history

active event

SSL

socket

URL options

source

authorisation right

licence

unique ID

environment variables

external type

encoding

external user types

external continues

sample criterion type

external criterion type

external files

source type

application visibility

application behaviour

application change

comparison

numeric comparison

value

comparison option

power state

power health

power confidence

power source type

power source capacity

day

days

longitude

latitude

astronomical sun event

audio device

audio volume

trigger type

notification

scope

power

scatter

quiet

drift

notification context

process signature type

user session type

condition type

requires

action type

behaviour

image

event activity

SSL allowances

SSL level

socket state

protocol family

port

time out

socket options

message level

URL

source state

domain type

right

access rights

authorisation rule

licence state

delay by seconds

Back to Developer Guide.