The cl-hue Reference Manual

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

The cl-hue Reference Manual

This is the cl-hue Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:43:30 2022 GMT+0.

Table of Contents


1 Introduction

cl-hue

Common Lisp client for Philips Hue API.

License

This code is licensed under the Apache 2 license.


2 Systems

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


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

2.1 cl-hue

Client for Philips Hue light controller

Author

Julien Danjou <julien@danjou.info>

License

Apache 2

Dependencies
  • drakma (system).
  • yason (system).
  • alexandria (system).
Source

cl-hue.asd.

Child Component

cl-hue.lisp (file).


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   [Contents][Index]

3.1.1 cl-hue/cl-hue.asd

Source

cl-hue.asd.

Parent Component

cl-hue (system).

ASDF Systems

cl-hue.


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

3.1.2 cl-hue/cl-hue.lisp

Source

cl-hue.asd.

Parent Component

cl-hue (system).

Packages

cl-hue.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 cl-hue

Source

cl-hue.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary 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.

Function: get-devices ()
Package

cl-hue.

Source

cl-hue.lisp.

Function: get-light (bridge number)

Get a specific light.

Package

cl-hue.

Source

cl-hue.lisp.

Function: get-lights (bridge)

Get lights status.

Package

cl-hue.

Source

cl-hue.lisp.

Function: make-bridge (&optional ip-address username)
Package

cl-hue.

Source

cl-hue.lisp.

Function: set-light-name (light name)
Package

cl-hue.

Source

cl-hue.lisp.

Function: set-light-name-by-number (bridge light-number name)
Package

cl-hue.

Source

cl-hue.lisp.

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.


5.1.2 Classes

Class: bridge
Package

cl-hue.

Source

cl-hue.lisp.

Direct methods
Direct slots
Slot: address
Initargs

:address

Readers

bridge-address.

Writers

(setf bridge-address).

Slot: username
Initargs

:username

Readers

bridge-username.

Writers

(setf bridge-username).

Class: light
Package

cl-hue.

Source

cl-hue.lisp.

Direct methods
Direct slots
Slot: bridge
Initargs

:bridge

Readers

light-bridge.

Writers

(setf light-bridge).

Slot: number
Package

common-lisp.

Initargs

:number

Readers

light-number.

Writers

(setf light-number).

Slot: type
Package

common-lisp.

Initargs

:type

Readers

light-type.

Writers

(setf light-type).

Slot: name
Initargs

:name

Readers

light-name.

Writers

(setf light-name).

Slot: modelid
Initargs

:modelid

Readers

light-modelid.

Writers

(setf light-modelid).

Slot: uniqueid
Initargs

:uniqueid

Readers

light-uniqueid.

Writers

(setf light-uniqueid).

Slot: swversion
Initargs

:swversion

Readers

light-swversion.

Writers

(setf light-swversion).

Slot: pointsymbol
Initargs

:pointsymbol

Readers

light-pointsymbol.

Writers

(setf light-pointsymbol).

Slot: on
Initargs

:on

Readers

light-on-p.

Writers

(setf light-on-p).

Slot: brightness
Initargs

:brightness

Readers

light-brightness.

Writers

(setf light-brightness).

Slot: hue
Initargs

:hue

Readers

light-hue.

Writers

(setf light-hue).

Slot: saturation
Initargs

:saturation

Readers

light-saturation.

Writers

(setf light-saturation).

Slot: xy
Initargs

:xy

Readers

light-xy.

Writers

(setf light-xy).

Slot: ct
Initargs

:ct

Readers

light-ct.

Writers

(setf light-ct).

Slot: alert
Initargs

:alert

Readers

light-alert.

Writers

(setf light-alert).

Slot: effect
Initargs

:effect

Readers

light-effect.

Writers

(setf light-effect).

Slot: colormode
Initargs

:colormode

Readers

light-colormode.

Writers

(setf light-colormode).

Slot: reachable
Initargs

:reachable

Readers

light-reachable-p.

Writers

(setf light-reachable-p).


5.2 Internals


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

5.2.1 Special variables

Special Variable: +meethue-url+
Package

cl-hue.

Source

cl-hue.lisp.


5.2.2 Ordinary functions

Function: extract-api-result (status)
Package

cl-hue.

Source

cl-hue.lisp.

Function: light-from-status (bridge number status)
Package

cl-hue.

Source

cl-hue.lisp.


5.2.3 Generic functions

Generic Reader: bridge-address (object)
Package

cl-hue.

Methods
Reader Method: bridge-address ((bridge bridge))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

address.

Generic Writer: (setf bridge-address) (object)
Package

cl-hue.

Methods
Writer Method: (setf bridge-address) ((bridge bridge))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

address.

Generic Reader: bridge-username (object)
Package

cl-hue.

Methods
Reader Method: bridge-username ((bridge bridge))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

username.

Generic Writer: (setf bridge-username) (object)
Package

cl-hue.

Methods
Writer Method: (setf bridge-username) ((bridge bridge))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

username.

Generic Reader: light-alert (object)
Package

cl-hue.

Methods
Reader Method: light-alert ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

alert.

Generic Writer: (setf light-alert) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-alert) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

alert.

Generic Reader: light-bridge (object)
Package

cl-hue.

Methods
Reader Method: light-bridge ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

bridge.

Generic Writer: (setf light-bridge) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-bridge) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

bridge.

Generic Reader: light-brightness (object)
Package

cl-hue.

Methods
Reader Method: light-brightness ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

brightness.

Generic Writer: (setf light-brightness) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-brightness) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

brightness.

Generic Reader: light-colormode (object)
Package

cl-hue.

Methods
Reader Method: light-colormode ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

colormode.

Generic Writer: (setf light-colormode) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-colormode) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

colormode.

Generic Reader: light-ct (object)
Package

cl-hue.

Methods
Reader Method: light-ct ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

ct.

Generic Writer: (setf light-ct) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-ct) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

ct.

Generic Reader: light-effect (object)
Package

cl-hue.

Methods
Reader Method: light-effect ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

effect.

Generic Writer: (setf light-effect) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-effect) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

effect.

Generic Reader: light-hue (object)
Package

cl-hue.

Methods
Reader Method: light-hue ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

hue.

Generic Writer: (setf light-hue) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-hue) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

hue.

Generic Reader: light-modelid (object)
Package

cl-hue.

Methods
Reader Method: light-modelid ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

modelid.

Generic Writer: (setf light-modelid) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-modelid) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

modelid.

Generic Reader: light-name (object)
Package

cl-hue.

Methods
Reader Method: light-name ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

name.

Generic Writer: (setf light-name) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-name) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

name.

Generic Reader: light-number (object)
Package

cl-hue.

Methods
Reader Method: light-number ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

number.

Generic Writer: (setf light-number) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-number) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

number.

Generic Reader: light-on-p (object)
Package

cl-hue.

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

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

on.

Generic Writer: (setf light-on-p) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-on-p) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

on.

Generic Reader: light-pointsymbol (object)
Package

cl-hue.

Methods
Reader Method: light-pointsymbol ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

pointsymbol.

Generic Writer: (setf light-pointsymbol) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-pointsymbol) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

pointsymbol.

Generic Reader: light-reachable-p (object)
Package

cl-hue.

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

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

reachable.

Generic Writer: (setf light-reachable-p) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-reachable-p) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

reachable.

Generic Reader: light-saturation (object)
Package

cl-hue.

Methods
Reader Method: light-saturation ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

saturation.

Generic Writer: (setf light-saturation) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-saturation) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

saturation.

Generic Reader: light-swversion (object)
Package

cl-hue.

Methods
Reader Method: light-swversion ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

swversion.

Generic Writer: (setf light-swversion) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-swversion) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

swversion.

Generic Reader: light-type (object)
Package

cl-hue.

Methods
Reader Method: light-type ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

type.

Generic Writer: (setf light-type) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-type) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

type.

Generic Reader: light-uniqueid (object)
Package

cl-hue.

Methods
Reader Method: light-uniqueid ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

uniqueid.

Generic Writer: (setf light-uniqueid) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-uniqueid) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

uniqueid.

Generic Reader: light-xy (object)
Package

cl-hue.

Methods
Reader Method: light-xy ((light light))

automatically generated reader method

Source

cl-hue.lisp.

Target Slot

xy.

Generic Writer: (setf light-xy) (object)
Package

cl-hue.

Methods
Writer Method: (setf light-xy) ((light light))

automatically generated writer method

Source

cl-hue.lisp.

Target Slot

xy.


Appendix A Indexes


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

A.1 Concepts


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): Private generic functions
(setf bridge-address): Private generic functions
(setf bridge-username): Private generic functions
(setf bridge-username): Private generic functions
(setf light-alert): Private generic functions
(setf light-alert): Private generic functions
(setf light-bridge): Private generic functions
(setf light-bridge): Private generic functions
(setf light-brightness): Private generic functions
(setf light-brightness): Private generic functions
(setf light-colormode): Private generic functions
(setf light-colormode): Private generic functions
(setf light-ct): Private generic functions
(setf light-ct): Private generic functions
(setf light-effect): Private generic functions
(setf light-effect): Private generic functions
(setf light-hue): Private generic functions
(setf light-hue): Private generic functions
(setf light-modelid): Private generic functions
(setf light-modelid): Private generic functions
(setf light-name): Private generic functions
(setf light-name): Private generic functions
(setf light-number): Private generic functions
(setf light-number): Private generic functions
(setf light-on-p): Private generic functions
(setf light-on-p): Private generic functions
(setf light-pointsymbol): Private generic functions
(setf light-pointsymbol): Private generic functions
(setf light-reachable-p): Private generic functions
(setf light-reachable-p): Private generic functions
(setf light-saturation): Private generic functions
(setf light-saturation): Private generic functions
(setf light-swversion): Private generic functions
(setf light-swversion): Private generic functions
(setf light-type): Private generic functions
(setf light-type): Private generic functions
(setf light-uniqueid): Private generic functions
(setf light-uniqueid): Private generic functions
(setf light-xy): Private generic functions
(setf light-xy): Private generic functions

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

C
create-user: Public ordinary functions

E
extract-api-result: Private ordinary functions

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

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

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

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

S
set-light-name: Public ordinary functions
set-light-name-by-number: Public ordinary functions
set-light-state-by-number: Public ordinary 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+: Private special variables

A
address: Public classes
alert: Public classes

B
bridge: Public classes
brightness: Public classes

C
colormode: Public classes
ct: Public classes

E
effect: Public classes

H
hue: Public classes

M
modelid: Public classes

N
name: Public classes
number: Public classes

O
on: Public classes

P
pointsymbol: Public classes

R
reachable: Public classes

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

T
type: Public classes

U
uniqueid: Public classes
username: Public classes

X
xy: Public classes

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