This is the nxt Reference Manual, version 0.0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:35:54 2020 GMT+0.
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The nxt system |
David Lichteblau, Willem Rein Oudshoorn <woudshoo@xs4all.nl>
BSD, see LICENSE file.
Implements the Lego Mindstorm NXT interface over Bluetooth, USB or a TCP proxy.
0.0.2
nxt.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The nxt/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
nxt.asd
nxt (system)
Next: The nxt/nxt-classes․lisp file, Previous: The nxt․asd file, Up: Lisp files [Contents][Index]
Next: The nxt/nxt-bluetooth․lisp file, Previous: The nxt/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
nxt (system)
nxt-classes.lisp
Next: The nxt/nxt-usb․lisp file, Previous: The nxt/nxt-classes․lisp file, Up: Lisp files [Contents][Index]
nxt-classes.lisp (file)
nxt (system)
nxt-bluetooth.lisp
Next: The nxt/nxt-command-infrastructure․lisp file, Previous: The nxt/nxt-bluetooth․lisp file, Up: Lisp files [Contents][Index]
nxt-bluetooth.lisp (file)
nxt (system)
nxt-usb.lisp
Next: The nxt/nxt-commands․lisp file, Previous: The nxt/nxt-usb․lisp file, Up: Lisp files [Contents][Index]
nxt-usb.lisp (file)
nxt (system)
nxt-command-infrastructure.lisp
Next: The nxt/nxt-utilities․lisp file, Previous: The nxt/nxt-command-infrastructure․lisp file, Up: Lisp files [Contents][Index]
nxt (system)
nxt-commands.lisp
ls-read (function)
Next: The nxt/nxt-motorcontrol․lisp file, Previous: The nxt/nxt-commands․lisp file, Up: Lisp files [Contents][Index]
nxt-commands.lisp (file)
nxt (system)
nxt-utilities.lisp
Next: The nxt/nxt-sensors․lisp file, Previous: The nxt/nxt-utilities․lisp file, Up: Lisp files [Contents][Index]
nxt-utilities.lisp (file)
nxt (system)
nxt-motorcontrol.lisp
Previous: The nxt/nxt-motorcontrol․lisp file, Up: Lisp files [Contents][Index]
nxt-motorcontrol.lisp (file)
nxt (system)
nxt-sensors.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The nxt.system package | ||
• The nxt package |
Next: The nxt package, Previous: Packages, Up: Packages [Contents][Index]
nxt.asd
Previous: The nxt․system package, Up: Packages [Contents][Index]
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
nxt-classes.lisp (file)
Holds the default NXT instance (which functions use by default, if no explicit NXT parameter is given. Replaces the old *connection* variable.
nxt-classes.lisp (file)
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-classes.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-classes.lisp (file)
nxt-usb.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-commands.lisp (file)
nxt-bluetooth.lisp (file)
nxt-classes.lisp (file)
nxt-sensors.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
nxt-usb.lisp (file)
nxt-bluetooth.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
nxt-bluetooth.lisp (file)
nxt (class)
:connection
connection (generic function)
(setf connection) (generic function)
0
read-timestamp (generic function)
(setf read-timestamp) (generic function)
0
write-timestamp (generic function)
(setf write-timestamp) (generic function)
Common superclass of BLUETOOTH-NXT and USB-NXT.
nxt-classes.lisp (file)
standard-object (class)
motor-states (generic function)
(setf motor-states) (generic function)
nxt-usb.lisp (file)
nxt (class)
:handle
handle (generic function)
(setf handle) (generic function)
:buf
buf (generic function)
(setf buf) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes | ||
• Internal types |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
Required delay in seconds when switching between reading from and writing to the brick in either direction.
nxt-bluetooth.lisp (file)
Required delay in seconds between successive writes to the brick.
nxt-bluetooth.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-usb.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Creates the command function ‘name’ which is a nxt command with the
two command identification bytes ‘type-code’ and ‘command-code’.
The ‘args’ contains key value pairs that should be taken by the function together
with a type specifier. Type specifiers are lists of the form (‘type’ ‘position’ rest).
The type is one of
ubyte - unsigned byte
uword - unsigned word (2 bytes)
ulong - unsigned long (4 bytes)
string - has additional parameter, ‘final-position’.
Creates a ‘parse-nxt-reply’ specialized ‘(eql code)’ to parse a nxt reply package.
The method ‘(parse-nxt-reply ((code (eql code)) (data vector)) ...)’
...
nxt-usb.lisp (file)
nxt-motorcontrol.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
nxt-bluetooth.lisp (file)
adds numbers, but lets symbols fall through
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-sensors.lisp (file)
nxt-utilities.lisp (file)
nxt-utilities.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-motorcontrol.lisp (file)
nxt-usb.lisp (file)
nxt-utilities.lisp (file)
nxt-utilities.lisp (file)
nxt-sensors.lisp (file)
nxt-utilities.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-usb.lisp (file)
nxt-commands.lisp (file)
Cached length of the frame, excluding variable-length DATA, but including fixed-length DATA (and, of course, also including the length parameter which DATA refers to, if any).
nxt-bluetooth.lisp (file)
nxt-bluetooth.lisp (file)
nxt-motorcontrol.lisp (file)
The offset of the first byte following the parameter.
Returns :unknown if the end is not known (for a DATA-PARAMETER).
The offset of the parameter’s last byte, i.e. the byte preceding PI-END. Returns :unknown if the end is not known (for a DATA-PARAMETER).
nxt-utilities.lisp (file)
nxt-sensors.lisp (file)
Read a 16 bit int from the nxt, lsb first.
nxt-bluetooth.lisp (file)
Extract unsigned byte value from the reply vector ‘vector’ at location ‘location’.
nxt-motorcontrol.lisp (file)
nxt-utilities.lisp (file)
nxt-sensors.lisp (file)
nxt-sensors.lisp (file)
nxt-utilities.lisp (file)
nxt-bluetooth.lisp (file)
Write a 16 bit int to the nxt lsb first.
nxt-bluetooth.lisp (file)
Put the value ‘value’ in the command vector ‘vector’ at location ‘location’.
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
automatically generated writer method
automatically generated reader method
nxt-usb.lisp (file)
automatically generated writer method
nxt-usb.lisp (file)
automatically generated reader method
nxt-classes.lisp (file)
automatically generated writer method
nxt-classes.lisp (file)
nxt-bluetooth.lisp (file)
automatically generated reader method
nxt-bluetooth.lisp (file)
automatically generated writer method
nxt-bluetooth.lisp (file)
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
nxt-usb.lisp (file)
automatically generated writer method
nxt-usb.lisp (file)
automatically generated reader method
nxt-classes.lisp (file)
automatically generated writer method
nxt-classes.lisp (file)
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
Returns the length in bytes occupied this parameter. The exception is if a ’data’ spec is present. The data is variable length and is not accounted for. However, if the size of the data is stored in the frame, the ubyte where the length of the data is stored IS taken into account.
(setf pi-nbytes) (generic function)
automatically generated reader method
pi-nbytes (generic function)
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
nxt-usb.lisp (file)
Read a reply from the nxt. It returns the content of the bluetooth or USB ’frame’, i.e. without length bytes.
nxt-bluetooth.lisp (file)
automatically generated reader method
nxt-bluetooth.lisp (file)
automatically generated writer method
nxt-bluetooth.lisp (file)
automatically generated reader method
automatically generated writer method
automatically generated reader method
nxt-bluetooth.lisp (file)
automatically generated writer method
nxt-bluetooth.lisp (file)
nxt-usb.lisp (file)
Writes the raw data vector prefixed by its length. This is to wrap the command in the bluetooth ’frame’ and send it over the wire, eh, air.
nxt-bluetooth.lisp (file)
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
parameter-info (class)
A data parameter which is specified as fixed-length in the protocol. This kind of parameter does not have a size field on the wire.
A data parameter which is variable-length, but does not have a size field on the wire. This type of parameter can occur only at the end of a frame.
variable-length-data-parameter (class)
A data parameter which is variable-length, but and stores its size
(plus the value of adjust-size) in a second parameter, the size-parameter,
which must precede the data.
variable-length-data-parameter (class)
:size-parameter
pi-size-parameter (generic function)
(setf pi-size-parameter) (generic function)
:adjust-size
pi-adjust-size (generic function)
(setf pi-adjust-size) (generic function)
standard-object (class)
%n-static-bytes (generic function)
(setf %n-static-bytes) (generic function)
:parameters
fi-parameters (generic function)
(setf fi-parameters) (generic function)
fi-explicit-parameters (generic function)
(setf fi-explicit-parameters) (generic function)
standard-object (class)
:name
fp-name (generic function)
(setf fp-name) (generic function)
:type-code
fp-type-code (generic function)
(setf fp-type-code) (generic function)
:command-code
fp-command-code (generic function)
(setf fp-command-code) (generic function)
:request
fp-request (generic function)
(setf fp-request) (generic function)
:reply
fp-reply (generic function)
(setf fp-reply) (generic function)
nxt-classes.lisp (file)
standard-object (class)
0
command-timestamp (generic function)
(setf command-timestamp) (generic function)
standard-object (class)
:nbytes
pi-nbytes (generic function)
(setf pi-nbytes) (generic function)
parameter-info (class)
size-parameter-p (generic function)
(setf size-parameter-p) (generic function)
standard-object (class)
:name
pi-name (generic function)
(setf pi-name) (generic function)
:offset
pi-offset (generic function)
(setf pi-offset) (generic function)
numeric-parameter (class)
numeric-parameter (class)
parameter-info (class)
numeric-parameter (class)
numeric-parameter (class)
numeric-parameter (class)
numeric-parameter (class)
data-parameter (class)
Previous: Internal classes, Up: Internal definitions [Contents][Index]
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L N |
---|
Jump to: | F L N |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
+
A B C D E F G H L M N O P Q R S T U V W |
---|
Jump to: | %
(
+
A B C D E F G H L M N O P Q R S T U V W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
A B C E H M N O P R S T W |
---|
Jump to: | *
+
A B C E H M N O P R S T W |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | B C D F M N P S T U V |
---|
Jump to: | B C D F M N P S T U V |
---|