The hu.dwim.bluez Reference Manual

Table of Contents

The hu.dwim.bluez Reference Manual

This is the hu.dwim.bluez Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 13:47:10 2020 GMT+0.

1 Introduction

hu.dwim.bluez

A Common Lisp FFI for Bluez (aka libbluetooth), which is a Linux Bluetooth stack.

Bugs, contributions

Written by attila@lendvai.name. The primary communication channel is the facilities on the project's GitHub page.

2 Systems

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

2.1 hu.dwim.bluez

Author

Attila Lendvai

License

BSD or Bugroff

Description

Common Lisp FFI wrapper for libbluetooth, aka Bluez, which is a Linux Bluetooth stack.

Version

0.1

Defsystem Dependency

cffi/c2ffi

Dependencies

• alexandria
• cffi
• cffi/c2ffi
• cffi-libffi

Source

hu.dwim.bluez.asd (file)

Components

• package-stage-1.lisp (file)
• ffi-prelude.lisp (file)
• source (module)
• c2ffi-spec (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 hu.dwim.bluez/source

Dependencies

• c2ffi-spec (module)
• package-stage-1.lisp (file)

Parent

hu.dwim.bluez (system)

Location

source/

Components

• package-stage-2.lisp (file)
• package-stage-3.lisp (file)
• bluez.lisp (file)

3.2 hu.dwim.bluez/c2ffi-spec

Dependency

ffi-prelude.lisp (file)

Parent

hu.dwim.bluez (system)

Location

c2ffi-spec/

Component

bluez.h (file)

4 Files

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

4.1 Lisp

4.1.1 hu.dwim.bluez.asd

Location

hu.dwim.bluez.asd

Systems

hu.dwim.bluez (system)

4.1.2 hu.dwim.bluez/package-stage-1.lisp

Parent

hu.dwim.bluez (system)

Location

source/package-stage-1.lisp

Packages

hu.dwim.bluez

4.1.3 hu.dwim.bluez/ffi-prelude.lisp

Dependency

package-stage-1.lisp (file)

Parent

hu.dwim.bluez (system)

Location

source/ffi-prelude.lisp

Internal Definitions

• bluez-error (condition)
• error-code-of (method)
• (setf error-code-of) (method)
• ffi-type-transformer (function)
• hci-error (condition)
• hci-error/negative-return-code (condition)
• hci-return-code (class)

4.1.4 hu.dwim.bluez/source/package-stage-2.lisp

Parent

source (module)

Location

source/package-stage-2.lisp

Internal Definitions

import-all-owned-symbols (function)

4.1.5 hu.dwim.bluez/source/package-stage-3.lisp

Dependency

package-stage-2.lisp (file)

Parent

source (module)

Location

source/package-stage-3.lisp

4.1.6 hu.dwim.bluez/source/bluez.lisp

Dependency

package-stage-3.lisp (file)

Parent

source (module)

Location

source/bluez.lisp

Exported Definitions

• +eir-device-id+ (constant)
• +eir-flags+ (constant)
• +eir-name-complete+ (constant)
• +eir-name-short+ (constant)
• +eir-tx-power+ (constant)
• +eir-uuid128-all+ (constant)
• +eir-uuid128-some+ (constant)
• +eir-uuid16-all+ (constant)
• +eir-uuid16-some+ (constant)
• +eir-uuid32-all+ (constant)
• +eir-uuid32-some+ (constant)
• bdaddr->string (function)
• c-fun/rc (macro)
• (setf fd-nonblocking-p) (function)
• hci-filter/clear (function)
• hci-filter/initialize-for-le-scanning (function)
• hci-filter/set-event (function)
• hci-filter/set-ptype (function)
• hci/adapter-name (function)
• hci/device-id (type)
• hci/is-device-le-capable? (function)
• hci/reset-adapter (function)
• parse-extended-inquiry-response (function)
• string->bdaddr (function)

Internal Definitions

• %c-fun/rc/check-error (function)
• %errno-location (function)
• %strerror (function)
• *errno* (symbol macro)
• c-fun (macro)
• c-ref (macro)
• copy-sap-to-byte-vector (function)
• fd (type)
• hci/bringup-device (function)
• hci/shutdown-device (function)
• htob/128 (function)
• htob/16 (function)
• htob/32 (function)
• htob/64 (function)
• strerror (function)

4.1.7 hu.dwim.bluez/c2ffi-spec/bluez.h

Parent

c2ffi-spec (module)

Location

c2ffi-spec/bluez.h

5 Packages

Packages are listed by definition order.

5.1 hu.dwim.bluez

Source

package-stage-1.lisp (file)

Use List

• cffi
• alexandria
• common-lisp

Exported Definitions

• +eir-device-id+ (constant)
• +eir-flags+ (constant)
• +eir-name-complete+ (constant)
• +eir-name-short+ (constant)
• +eir-tx-power+ (constant)
• +eir-uuid128-all+ (constant)
• +eir-uuid128-some+ (constant)
• +eir-uuid16-all+ (constant)
• +eir-uuid16-some+ (constant)
• +eir-uuid32-all+ (constant)
• +eir-uuid32-some+ (constant)
• bdaddr->string (function)
• c-fun/rc (macro)
• (setf fd-nonblocking-p) (function)
• hci-filter/clear (function)
• hci-filter/initialize-for-le-scanning (function)
• hci-filter/set-event (function)
• hci-filter/set-ptype (function)
• hci/adapter-name (function)
• hci/device-id (type)
• hci/is-device-le-capable? (function)
• hci/reset-adapter (function)
• parse-extended-inquiry-response (function)
• string->bdaddr (function)

Internal Definitions

• %c-fun/rc/check-error (function)
• %errno-location (function)
• %strerror (function)
• *errno* (symbol macro)
• bluez-error (condition)
• c-fun (macro)
• c-ref (macro)
• copy-sap-to-byte-vector (function)
• error-code-of (generic function)
• error-code-of (method)
• (setf error-code-of) (method)
• (setf error-code-of) (generic function)
• fd (type)
• ffi-type-transformer (function)
• hci-error (condition)
• hci-error/negative-return-code (condition)
• hci-return-code (class)
• hci/bringup-device (function)
• hci/shutdown-device (function)
• htob/128 (function)
• htob/16 (function)
• htob/32 (function)
• htob/64 (function)
• import-all-owned-symbols (function)
• strerror (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +eir-device-id+

device ID

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-flags+

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-name-complete+

complete local name

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-name-short+

shortened local name

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-tx-power+

transmit power level

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-uuid128-all+

128-bit UUID, all listed

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-uuid128-some+

128-bit UUID, more available

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-uuid16-all+

16-bit UUID, all listed

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-uuid16-some+

16-bit UUID, more available

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-uuid32-all+

32-bit UUID, all listed

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Constant: +eir-uuid32-some+

32-bit UUID, more available

Package

hu.dwim.bluez

Source

bluez.lisp (file)

6.1.2 Macros

Macro: c-fun/rc FN-NAME &rest ARGS

Package

hu.dwim.bluez

Source

bluez.lisp (file)

6.1.3 Functions

Function: bdaddr->string BDADDR

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: (setf fd-nonblocking-p) ENABLED FD

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci-filter/clear FILTER

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci-filter/initialize-for-le-scanning FILTER

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci-filter/set-event EVENT FILTER

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci-filter/set-ptype TYPE FILTER

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci/adapter-name DEVICE-ID

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci/is-device-le-capable? DEVICE-ID

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci/reset-adapter DEVICE-ID

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: parse-extended-inquiry-response EIR EIR-LENGTH

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: string->bdaddr STR BDADDR

Package

hu.dwim.bluez

Source

bluez.lisp (file)

6.1.4 Types

Type: hci/device-id ()

Package

hu.dwim.bluez

Source

bluez.lisp (file)

6.2 Internal definitions

6.2.1 Symbol macros

Symbol Macro: *errno*

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Expansion

(cffi:mem-ref (hu.dwim.bluez::%errno-location) :int)

6.2.2 Macros

Macro: c-fun FN-NAME &rest ARGS

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Macro: c-ref OBJECT TYPE SLOT

Package

hu.dwim.bluez

Source

bluez.lisp (file)

6.2.3 Functions

Function: %c-fun/rc/check-error RC FN-NAME WHOLE-FORM

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: %errno-location ()

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: %strerror ERRNO

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: copy-sap-to-byte-vector POINTER SIZE

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: ffi-type-transformer TYPE CONTEXT &rest ARGS &key &allow-other-keys

Package

hu.dwim.bluez

Source

ffi-prelude.lisp (file)

Function: hci/bringup-device SOCKET DEVICE-ID

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: hci/shutdown-device SOCKET DEVICE-ID

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: htob/128 VALUE

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: htob/16 VALUE

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: htob/32 VALUE

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: htob/64 VALUE

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Function: import-all-owned-symbols SOURCE-PACKAGE TARGET-PACKAGE &key OVERWRITE

Package

hu.dwim.bluez

Source

package-stage-2.lisp (file)

Function: strerror &optional ERRNO

Package

hu.dwim.bluez

Source

bluez.lisp (file)

6.2.4 Generic functions

Generic Function: error-code-of CONDITION

Generic Function: (setf error-code-of) NEW-VALUE CONDITION

Package

hu.dwim.bluez

Methods

Method: error-code-of (CONDITION hci-error/negative-return-code)

Method: (setf error-code-of) NEW-VALUE (CONDITION hci-error/negative-return-code)

Source

ffi-prelude.lisp (file)

6.2.5 Conditions

Condition: bluez-error ()

Package

hu.dwim.bluez

Source

ffi-prelude.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

hci-error (condition)

Condition: hci-error ()

Package

hu.dwim.bluez

Source

ffi-prelude.lisp (file)

Direct superclasses

bluez-error (condition)

Direct subclasses

hci-error/negative-return-code (condition)

Condition: hci-error/negative-return-code ()

Package

hu.dwim.bluez

Source

ffi-prelude.lisp (file)

Direct superclasses

• hci-error (condition)
• simple-error (condition)

Direct methods

• error-code-of (method)
• error-code-of (method)

Direct slots

Slot: error-code

Initargs

:error-code

Initform

(quote (error "must specify error-code."))

Readers

error-code-of (generic function)

Writers

(setf error-code-of) (generic function)

6.2.6 Classes

Class: hci-return-code ()

Package

hu.dwim.bluez

Source

ffi-prelude.lisp (file)

Direct superclasses

foreign-type-alias (class)

Direct methods

expand-from-foreign (method)

Direct Default Initargs

Initarg	Value
:actual-type	(cffi::parse-type :int)

6.2.7 Types

Type: fd ()

Package

hu.dwim.bluez

Source

bluez.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types