Add the current ideas about pictograms.
This commit is contained in:
@@ -41,7 +41,98 @@ term <termdef>pictogram</termdef> has been chosen.</para></note>
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Client language</title>
|
||||
<para>This section should talk about the client language.</para>
|
||||
<para>
|
||||
There are two language commands that can be called by the client:
|
||||
pictograms_get and pictogram_set.
|
||||
</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>pictograms_get</command>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>This command may be called by a client to get a list of
|
||||
available pictograms. If pictograms are not support by the
|
||||
particular version of LCDd, it will respond with an error
|
||||
message (huh? unknown command).</para>
|
||||
|
||||
<note>
|
||||
<para>Clients should either check the version number returned as
|
||||
response to the 'hello' command or the response to
|
||||
'pictograms_get' to check if LCDd supports pictograms before
|
||||
calling 'pictogram_set' (see below).</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The response will be a string in the format:
|
||||
</para>
|
||||
<para>
|
||||
<computeroutput>pictograms <replaceable>pictogram list</replaceable>...</computeroutput>
|
||||
</para>
|
||||
<para>
|
||||
The pictogram list will be a sequence of pictogram
|
||||
definitions separated by a space character. Each pictogram
|
||||
definition consists of up to four fields separated by a colon.
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<computeroutput><replaceable>Name</replaceable></computeroutput>
|
||||
</term>
|
||||
<listitem><para>
|
||||
The text representation of the pictogram name.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<computeroutput><replaceable>Type</replaceable></computeroutput>
|
||||
</term>
|
||||
<listitem><para>
|
||||
The type of the pictogram: 'n' for numerical pictograms
|
||||
and 'b' for boolean type pictograms.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<computeroutput><replaceable>Group ID</replaceable></computeroutput>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>The Group ID is optional and if present is a number greater than zero
|
||||
that models the driver's idea of a several pictograms that form a group. This
|
||||
may e.g. be used for media source pictograms.</para>
|
||||
<note>
|
||||
<para>The group ID is only informational for the client and is not used
|
||||
within LCDd. The driver however may make use of groups internally.</para>
|
||||
</note>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<computeroutput><replaceable>Group type</replaceable></computeroutput>
|
||||
</term>
|
||||
<listitem><para>
|
||||
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>pictogram_set
|
||||
<option><replaceable>pictogram</replaceable>:<replaceable>value</replaceable></option>
|
||||
</command>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</sect1>
|
||||
|
||||
<sect1><title>Driver API</title>
|
||||
|
||||
@@ -77,7 +77,7 @@
|
||||
#define AUTO_READ 0xb1
|
||||
#define AUTO_RESET 0xb2
|
||||
|
||||
/* 'Status read' anwer codes */
|
||||
/* 'Status read' answer codes */
|
||||
#define STA0 0x01
|
||||
#define STA1 0x02
|
||||
#define STA3 0x08
|
||||
|
||||
Reference in New Issue
Block a user