The cl-hue Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-hue Reference Manual

This is the cl-hue Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:21:50 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-hue

Common Lisp client for Philips Hue API.

License

This code is licensed under the Apache 2 license.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-hue

Author

Julien Danjou <julien@danjou.info>

License

Apache 2

Description

Client for Philips Hue light controller

Dependencies
Source

cl-hue.asd (file)

Component

cl-hue.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-hue.asd

Location

cl-hue.asd

Systems

cl-hue (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-hue/cl-hue.lisp

Parent

cl-hue (system)

Location

cl-hue.lisp

Packages

cl-hue

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-hue

Source

cl-hue.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: create-user BRIDGE-ADDRESS &optional DEVICE-TYPE USERNAME

Register an application against the bridge.

Return a username value (a kind of token) that must be used to access the bridege.

Package

cl-hue

Source

cl-hue.lisp (file)

Function: get-devices ()
Package

cl-hue

Source

cl-hue.lisp (file)

Function: get-light BRIDGE NUMBER

Get a specific light.

Package

cl-hue

Source

cl-hue.lisp (file)

Function: get-lights BRIDGE

Get lights status.

Package

cl-hue

Source

cl-hue.lisp (file)

Function: make-bridge &optional IP-ADDRESS USERNAME
Package

cl-hue

Source

cl-hue.lisp (file)

Function: set-light-name LIGHT NAME
Package

cl-hue

Source

cl-hue.lisp (file)

Function: set-light-name-by-number BRIDGE LIGHT-NUMBER NAME
Package

cl-hue

Source

cl-hue.lisp (file)

Function: set-light-state-by-number BRIDGE LIGHT-NUMBER &key ON BRIGHTNESS HUE SATURATION XY CT ALERT EFFECT TRANSITIONTIME
Package

cl-hue

Source

cl-hue.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: bridge ()
Package

cl-hue

Source

cl-hue.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: address
Initargs

:address

Readers

bridge-address (generic function)

Writers

(setf bridge-address) (generic function)

Slot: username
Initargs

:username

Readers

bridge-username (generic function)

Writers

(setf bridge-username) (generic function)

Class: light ()
Package

cl-hue

Source

cl-hue.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: bridge
Initargs

:bridge

Readers

light-bridge (generic function)

Writers

(setf light-bridge) (generic function)

Slot: number
Initargs

:number

Readers

light-number (generic function)

Writers

(setf light-number) (generic function)

Slot: type
Initargs

:type

Readers

light-type (generic function)

Writers

(setf light-type) (generic function)

Slot: name
Initargs

:name

Readers

light-name (generic function)

Writers

(setf light-name) (generic function)

Slot: modelid
Initargs

:modelid

Readers

light-modelid (generic function)

Writers

(setf light-modelid) (generic function)

Slot: uniqueid
Initargs

:uniqueid

Readers

light-uniqueid (generic function)

Writers

(setf light-uniqueid) (generic function)

Slot: swversion
Initargs

:swversion

Readers

light-swversion (generic function)

Writers

(setf light-swversion) (generic function)

Slot: pointsymbol
Initargs

:pointsymbol

Readers

light-pointsymbol (generic function)

Writers

(setf light-pointsymbol) (generic function)

Slot: on
Initargs

:on

Readers

light-on-p (generic function)

Writers

(setf light-on-p) (generic function)

Slot: brightness
Initargs

:brightness

Readers

light-brightness (generic function)

Writers

(setf light-brightness) (generic function)

Slot: hue
Initargs

:hue

Readers

light-hue (generic function)

Writers

(setf light-hue) (generic function)

Slot: saturation
Initargs

:saturation

Readers

light-saturation (generic function)

Writers

(setf light-saturation) (generic function)

Slot: xy
Initargs

:xy

Readers

light-xy (generic function)

Writers

(setf light-xy) (generic function)

Slot: ct
Initargs

:ct

Readers

light-ct (generic function)

Writers

(setf light-ct) (generic function)

Slot: alert
Initargs

:alert

Readers

light-alert (generic function)

Writers

(setf light-alert) (generic function)

Slot: effect
Initargs

:effect

Readers

light-effect (generic function)

Writers

(setf light-effect) (generic function)

Slot: colormode
Initargs

:colormode

Readers

light-colormode (generic function)

Writers

(setf light-colormode) (generic function)

Slot: reachable
Initargs

:reachable

Readers

light-reachable-p (generic function)

Writers

(setf light-reachable-p) (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: +meethue-url+
Package

cl-hue

Source

cl-hue.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: extract-api-result STATUS
Package

cl-hue

Source

cl-hue.lisp (file)

Function: light-from-status BRIDGE NUMBER STATUS
Package

cl-hue

Source

cl-hue.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Generic functions

Generic Function: bridge-address OBJECT
Generic Function: (setf bridge-address) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: bridge-address (BRIDGE bridge)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf bridge-address) NEW-VALUE (BRIDGE bridge)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: bridge-username OBJECT
Generic Function: (setf bridge-username) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: bridge-username (BRIDGE bridge)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf bridge-username) NEW-VALUE (BRIDGE bridge)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-alert OBJECT
Generic Function: (setf light-alert) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-alert (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-alert) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-bridge OBJECT
Generic Function: (setf light-bridge) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-bridge (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-bridge) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-brightness OBJECT
Generic Function: (setf light-brightness) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-brightness (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-brightness) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-colormode OBJECT
Generic Function: (setf light-colormode) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-colormode (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-colormode) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-ct OBJECT
Generic Function: (setf light-ct) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-ct (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-ct) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-effect OBJECT
Generic Function: (setf light-effect) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-effect (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-effect) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-hue OBJECT
Generic Function: (setf light-hue) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-hue (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-hue) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-modelid OBJECT
Generic Function: (setf light-modelid) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-modelid (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-modelid) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-name OBJECT
Generic Function: (setf light-name) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-name (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-name) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-number OBJECT
Generic Function: (setf light-number) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-number (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-number) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-on-p OBJECT
Generic Function: (setf light-on-p) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-on-p (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-on-p) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-pointsymbol OBJECT
Generic Function: (setf light-pointsymbol) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-pointsymbol (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-pointsymbol) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-reachable-p OBJECT
Generic Function: (setf light-reachable-p) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-reachable-p (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-reachable-p) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-saturation OBJECT
Generic Function: (setf light-saturation) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-saturation (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-saturation) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-swversion OBJECT
Generic Function: (setf light-swversion) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-swversion (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-swversion) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-type OBJECT
Generic Function: (setf light-type) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-type (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-type) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-uniqueid OBJECT
Generic Function: (setf light-uniqueid) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-uniqueid (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-uniqueid) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)

Generic Function: light-xy OBJECT
Generic Function: (setf light-xy) NEW-VALUE OBJECT
Package

cl-hue

Methods
Method: light-xy (LIGHT light)

automatically generated reader method

Source

cl-hue.lisp (file)

Method: (setf light-xy) NEW-VALUE (LIGHT light)

automatically generated writer method

Source

cl-hue.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-hue.asd: The cl-hue<dot>asd file
cl-hue/cl-hue.lisp: The cl-hue/cl-hue<dot>lisp file

F
File, Lisp, cl-hue.asd: The cl-hue<dot>asd file
File, Lisp, cl-hue/cl-hue.lisp: The cl-hue/cl-hue<dot>lisp file

L
Lisp File, cl-hue.asd: The cl-hue<dot>asd file
Lisp File, cl-hue/cl-hue.lisp: The cl-hue/cl-hue<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   C   E   F   G   L   M   S  
Index Entry  Section

(
(setf bridge-address): Internal generic functions
(setf bridge-address): Internal generic functions
(setf bridge-username): Internal generic functions
(setf bridge-username): Internal generic functions
(setf light-alert): Internal generic functions
(setf light-alert): Internal generic functions
(setf light-bridge): Internal generic functions
(setf light-bridge): Internal generic functions
(setf light-brightness): Internal generic functions
(setf light-brightness): Internal generic functions
(setf light-colormode): Internal generic functions
(setf light-colormode): Internal generic functions
(setf light-ct): Internal generic functions
(setf light-ct): Internal generic functions
(setf light-effect): Internal generic functions
(setf light-effect): Internal generic functions
(setf light-hue): Internal generic functions
(setf light-hue): Internal generic functions
(setf light-modelid): Internal generic functions
(setf light-modelid): Internal generic functions
(setf light-name): Internal generic functions
(setf light-name): Internal generic functions
(setf light-number): Internal generic functions
(setf light-number): Internal generic functions
(setf light-on-p): Internal generic functions
(setf light-on-p): Internal generic functions
(setf light-pointsymbol): Internal generic functions
(setf light-pointsymbol): Internal generic functions
(setf light-reachable-p): Internal generic functions
(setf light-reachable-p): Internal generic functions
(setf light-saturation): Internal generic functions
(setf light-saturation): Internal generic functions
(setf light-swversion): Internal generic functions
(setf light-swversion): Internal generic functions
(setf light-type): Internal generic functions
(setf light-type): Internal generic functions
(setf light-uniqueid): Internal generic functions
(setf light-uniqueid): Internal generic functions
(setf light-xy): Internal generic functions
(setf light-xy): Internal generic functions

B
bridge-address: Internal generic functions
bridge-address: Internal generic functions
bridge-username: Internal generic functions
bridge-username: Internal generic functions

C
create-user: Exported functions

E
extract-api-result: Internal functions

F
Function, create-user: Exported functions
Function, extract-api-result: Internal functions
Function, get-devices: Exported functions
Function, get-light: Exported functions
Function, get-lights: Exported functions
Function, light-from-status: Internal functions
Function, make-bridge: Exported functions
Function, set-light-name: Exported functions
Function, set-light-name-by-number: Exported functions
Function, set-light-state-by-number: Exported functions

G
Generic Function, (setf bridge-address): Internal generic functions
Generic Function, (setf bridge-username): Internal generic functions
Generic Function, (setf light-alert): Internal generic functions
Generic Function, (setf light-bridge): Internal generic functions
Generic Function, (setf light-brightness): Internal generic functions
Generic Function, (setf light-colormode): Internal generic functions
Generic Function, (setf light-ct): Internal generic functions
Generic Function, (setf light-effect): Internal generic functions
Generic Function, (setf light-hue): Internal generic functions
Generic Function, (setf light-modelid): Internal generic functions
Generic Function, (setf light-name): Internal generic functions
Generic Function, (setf light-number): Internal generic functions
Generic Function, (setf light-on-p): Internal generic functions
Generic Function, (setf light-pointsymbol): Internal generic functions
Generic Function, (setf light-reachable-p): Internal generic functions
Generic Function, (setf light-saturation): Internal generic functions
Generic Function, (setf light-swversion): Internal generic functions
Generic Function, (setf light-type): Internal generic functions
Generic Function, (setf light-uniqueid): Internal generic functions
Generic Function, (setf light-xy): Internal generic functions
Generic Function, bridge-address: Internal generic functions
Generic Function, bridge-username: Internal generic functions
Generic Function, light-alert: Internal generic functions
Generic Function, light-bridge: Internal generic functions
Generic Function, light-brightness: Internal generic functions
Generic Function, light-colormode: Internal generic functions
Generic Function, light-ct: Internal generic functions
Generic Function, light-effect: Internal generic functions
Generic Function, light-hue: Internal generic functions
Generic Function, light-modelid: Internal generic functions
Generic Function, light-name: Internal generic functions
Generic Function, light-number: Internal generic functions
Generic Function, light-on-p: Internal generic functions
Generic Function, light-pointsymbol: Internal generic functions
Generic Function, light-reachable-p: Internal generic functions
Generic Function, light-saturation: Internal generic functions
Generic Function, light-swversion: Internal generic functions
Generic Function, light-type: Internal generic functions
Generic Function, light-uniqueid: Internal generic functions
Generic Function, light-xy: Internal generic functions
get-devices: Exported functions
get-light: Exported functions
get-lights: Exported functions

L
light-alert: Internal generic functions
light-alert: Internal generic functions
light-bridge: Internal generic functions
light-bridge: Internal generic functions
light-brightness: Internal generic functions
light-brightness: Internal generic functions
light-colormode: Internal generic functions
light-colormode: Internal generic functions
light-ct: Internal generic functions
light-ct: Internal generic functions
light-effect: Internal generic functions
light-effect: Internal generic functions
light-from-status: Internal functions
light-hue: Internal generic functions
light-hue: Internal generic functions
light-modelid: Internal generic functions
light-modelid: Internal generic functions
light-name: Internal generic functions
light-name: Internal generic functions
light-number: Internal generic functions
light-number: Internal generic functions
light-on-p: Internal generic functions
light-on-p: Internal generic functions
light-pointsymbol: Internal generic functions
light-pointsymbol: Internal generic functions
light-reachable-p: Internal generic functions
light-reachable-p: Internal generic functions
light-saturation: Internal generic functions
light-saturation: Internal generic functions
light-swversion: Internal generic functions
light-swversion: Internal generic functions
light-type: Internal generic functions
light-type: Internal generic functions
light-uniqueid: Internal generic functions
light-uniqueid: Internal generic functions
light-xy: Internal generic functions
light-xy: Internal generic functions

M
make-bridge: Exported functions
Method, (setf bridge-address): Internal generic functions
Method, (setf bridge-username): Internal generic functions
Method, (setf light-alert): Internal generic functions
Method, (setf light-bridge): Internal generic functions
Method, (setf light-brightness): Internal generic functions
Method, (setf light-colormode): Internal generic functions
Method, (setf light-ct): Internal generic functions
Method, (setf light-effect): Internal generic functions
Method, (setf light-hue): Internal generic functions
Method, (setf light-modelid): Internal generic functions
Method, (setf light-name): Internal generic functions
Method, (setf light-number): Internal generic functions
Method, (setf light-on-p): Internal generic functions
Method, (setf light-pointsymbol): Internal generic functions
Method, (setf light-reachable-p): Internal generic functions
Method, (setf light-saturation): Internal generic functions
Method, (setf light-swversion): Internal generic functions
Method, (setf light-type): Internal generic functions
Method, (setf light-uniqueid): Internal generic functions
Method, (setf light-xy): Internal generic functions
Method, bridge-address: Internal generic functions
Method, bridge-username: Internal generic functions
Method, light-alert: Internal generic functions
Method, light-bridge: Internal generic functions
Method, light-brightness: Internal generic functions
Method, light-colormode: Internal generic functions
Method, light-ct: Internal generic functions
Method, light-effect: Internal generic functions
Method, light-hue: Internal generic functions
Method, light-modelid: Internal generic functions
Method, light-name: Internal generic functions
Method, light-number: Internal generic functions
Method, light-on-p: Internal generic functions
Method, light-pointsymbol: Internal generic functions
Method, light-reachable-p: Internal generic functions
Method, light-saturation: Internal generic functions
Method, light-swversion: Internal generic functions
Method, light-type: Internal generic functions
Method, light-uniqueid: Internal generic functions
Method, light-xy: Internal generic functions

S
set-light-name: Exported functions
set-light-name-by-number: Exported functions
set-light-state-by-number: Exported functions

Jump to:   (  
B   C   E   F   G   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
A   B   C   E   H   M   N   O   P   R   S   T   U   X  
Index Entry  Section

+
+meethue-url+: Internal special variables

A
address: Exported classes
alert: Exported classes

B
bridge: Exported classes
brightness: Exported classes

C
colormode: Exported classes
ct: Exported classes

E
effect: Exported classes

H
hue: Exported classes

M
modelid: Exported classes

N
name: Exported classes
number: Exported classes

O
on: Exported classes

P
pointsymbol: Exported classes

R
reachable: Exported classes

S
saturation: Exported classes
Slot, address: Exported classes
Slot, alert: Exported classes
Slot, bridge: Exported classes
Slot, brightness: Exported classes
Slot, colormode: Exported classes
Slot, ct: Exported classes
Slot, effect: Exported classes
Slot, hue: Exported classes
Slot, modelid: Exported classes
Slot, name: Exported classes
Slot, number: Exported classes
Slot, on: Exported classes
Slot, pointsymbol: Exported classes
Slot, reachable: Exported classes
Slot, saturation: Exported classes
Slot, swversion: Exported classes
Slot, type: Exported classes
Slot, uniqueid: Exported classes
Slot, username: Exported classes
Slot, xy: Exported classes
Special Variable, +meethue-url+: Internal special variables
swversion: Exported classes

T
type: Exported classes

U
uniqueid: Exported classes
username: Exported classes

X
xy: Exported classes

Jump to:   +  
A   B   C   E   H   M   N   O   P   R   S   T   U   X  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   L   P   S  
Index Entry  Section

B
bridge: Exported classes

C
cl-hue: The cl-hue system
cl-hue: The cl-hue package
Class, bridge: Exported classes
Class, light: Exported classes

L
light: Exported classes

P
Package, cl-hue: The cl-hue package

S
System, cl-hue: The cl-hue system

Jump to:   B   C   L   P   S