Please also read the Disclaimer

The client is the portal thru which you can construct and control your xPLMyHouse system

The most important items on the House menu are "Live", "Event" and "Design" modes

The client can be optionally started with command line options

You can specify the initial floor to display (e.g. upstairs or "ground floor")

You can specify kiosk, this launches in kiosk mode (full screen). To exit kiosk mode (if launched in kiosk mode it closes app, if selected from window menu it returns to windowed mode) by clicking the top or bottom left hand corners. Click the right hand edge scrolls out a menu with the floors as thumbnails for selection. In the kiosk mode clicking a device shows the status box, holding down displays a larger menu. These last 2 items are for touch screen use which is what kiosk mode is intended for

xPLMyHouse Client running in Kiosk mode
on an Apple iPad (via iTap RDP)

Live Mode

Live mode is like the web interface in that it's used for control and viewing of you xPL devices

In live mode each floor design is centred in the window automatically (so in design mode work from top left to minimise blank borders)

Any change at the pivot is passed to the client and displayed live on this screen.

Right-clicking a device offers various control options, and moving the mouse over a device pops up a box of information

House Menu

Refresh Device States - causes xPL messages to request states be sent where supported by device
Redraw Floor - a utility function to redraw the current floor
Globals Manager - launches a form to view/maintain global variables
Refresh Device States - causes xPL messages to request states be sent where supported by device
Scripting / Script Editor - launches the built-in VB Script Editor
Scripting / Reload Scripts - causes Pivot to reload the VB Scripts
Settings / Device Manager - enables/disabled the optional xpl device manager
Settings / Clear Widget Box.. - number of seconds to wait before clearing statusbox/webcam/medianet box
System Logs - various items to view/clear the system and error logs
Exit - close the client

xPL Menu

Device Manager - displays the device manager for active devices
Device Manager (All) - displays the device manager for all devices
Monitor - launches a simple xPL message monitor
Send Message - launches a form to send manual xPL messages

Window Menu

Kiosk - enters kiosk mode

Help Menu

Client Update - the current client downloads latest image and webcam files from pivot
Data Backup - instructs the pivot to back up the data store
Restart Pivot - instructs pivot to restart (all clients will also restart)
Shutdown Pivot - instructs pivot to shutdown (all client will restart and wait)
About - display current version

Most of the above items are also present in Design / Event mode so will not be repeated below

Location Context Menu

Set Occupied / Set Unoccupied - change occupancy state of location

Door Context Menu

Set Open / Set Closed - change open state of door

Device Context Menu

List of States - change device state (available options depend on sanity with current state)
List of Actions - actions that can be performed on device in current state
List of Attributes - attribute values that can be changed in current state
List of Events - list of events that can be run / view logged state/status/attrib changes
Request State - sends a state request if applicable to device type
For security Areas and Zones it also shows various related states and actions
 

Events Mode

On leaving events mode you will be asked to save changes (with option to backup data) if anything has been changed

Events Menu

Lists all known events by Room and Device for quick access

Room Context Menu

New Event - pops up form to create a new event for this device
(List of Existing Events)
Log State Changes - tick this to log state changes
Properties - pops up for to enter occupancy timeouts

Device Context Menu

New Event - pops up form to create a new event for this device
(List of Existing Events)
Log State Changes - tick this to log state changes (devices with states)
Log Status Changes - tick this to log status changes (devices with statuses)
Log Attribute Changes - tick this to log attribute changes (devices with attributes)

Design Mode

On leaving design mode you will be asked to save changes (with option to backup data) if anything has been changed

Floors Menu

New Floor - add a new floor
Rename - rename current floor
Delete - delete current floor

Locations Menu

New Location - add a new location (4, 6 or 8 cornered)
Rotate - rotate current location left/right
Rename - rename current location
Delete - delete current location

Doors Menu

New Door - add a new door
Rename - rename current door
Delete - delete current door

Device Menu

New Device - selecting a device type pops up a form to create device
Properties - display/edit current devices properties
Delete - delete current device

Tools Menu

Move Layout - still under development, use with caution
Resize Layout - still under development, use with caution

Location Context Menu

Linked to - define links to other locations (for occupancy)
Rotate Left - rotate location left
Rotate Right - rotate location right
Rename - rename location
Delete - delete location

Door Context Menu

Rename - rename door
Delete - delete door

Device Context Menu

Properties - pop up form to edit device properties
State Images - popup form to override standard state images for device
Create Alias - create alias for device supporting aliasing
Create Clone - create clone for device supporting cloning
Move to - move to (a list of other floors)
Area Alarm Type - specify alarm type for an area (devices that can be alarm areas)
Security Area - select security area (for devices that can be security zones)
Security Zone Type - select security zone type (for devices in a security area)
Security Alarm Trigger - select state to trigger alarm (for devices in a security area)
Entry / Exit Point - select if this is a security entry point (for devices that can be security zones)
Delete - delete device