aboutsummaryrefslogtreecommitdiffstats
path: root/lib/lufa/Projects/LEDNotifier
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-06-05 11:21:37 -0400
committerJack Humbert <jack.humb@gmail.com>2016-06-05 11:21:37 -0400
commit3e3a07fc97d66d5f001aa3da4496d1268f4797cc (patch)
treef990493882fe47d3335146f75481c7b1edd251c2 /lib/lufa/Projects/LEDNotifier
parentbdf94c0621c4d1293618cab9589e593c3d713852 (diff)
downloadfirmware-3e3a07fc97d66d5f001aa3da4496d1268f4797cc.tar.gz
firmware-3e3a07fc97d66d5f001aa3da4496d1268f4797cc.tar.bz2
firmware-3e3a07fc97d66d5f001aa3da4496d1268f4797cc.zip
adds planck keymap readme
Diffstat (limited to 'lib/lufa/Projects/LEDNotifier')
0 files changed, 0 insertions, 0 deletions
n119'>119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
%
% Copyright (c) 2006 XenSource, Inc.
%
% Permission is granted to copy, distribute and/or modify this document under
% the terms of the GNU Free Documentation License, Version 1.2 or any later
% version published by the Free Software Foundation; with no Invariant
% Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy of the
% license is included in the section entitled
% "GNU Free Documentation License" or the file fdl.tex.
%
% Authors: Ewan Mellor, Richard Sharp, Dave Scott, Jon Harrop.
%

The API is presented here as a set of Remote Procedure Calls, with a wire
format based upon XML-RPC. No specific language bindings are prescribed,
although examples will be given in the python programming language.
 
Although we adopt some terminology from object-oriented programming, 
future client language bindings may or may not be object oriented.
The API reference uses the terminology {\em classes\/} and {\em objects\/}.
For our purposes a {\em class\/} is simply a hierarchical namespace;
an {\em object\/} is an instance of a class with its fields set to
specific values. Objects are persistent and exist on the server-side.
Clients may obtain opaque references to these server-side objects and then
access their fields via get/set RPCs.

%In each class there is a $\mathit{uid}$ field that assigns an indentifier
%to each object. This $\mathit{uid}$ serves as an object reference
%on both client- and server-side, and is often included as an argument in
%RPC messages.

For each class we specify a list of
fields along with their {\em types\/} and {\em qualifiers\/}.  A
qualifier is one of:
\begin{itemize}
  \item $\mathit{RO}_\mathit{run}$: the field is Read
Only. Furthermore, its value is automatically computed at runtime.
For example: current CPU load and disk IO throughput.