chromex.app.bluetooth-socket — binaryage/chromex 0.6.3

clj

Use the chrome.bluetoothSocket API to send and receive data to Bluetooth devices using RFCOMM and L2CAP connections.

• available since Chrome 37
• https://developer.chrome.com/apps/bluetoothSocket

api-table clj

close clj/s macro

(close socket-id)

Disconnects and destroys the socket. Each socket created should be closed after use. The socket id is no longer valid as soon at the function is called. However, the socket is guaranteed to be closed only when the callback is invoked.

|socket-id| - The socket identifier.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-close.

close* cljs

(close* config socket-id)

connect clj/s macro

(connect socket-id address uuid)

Connects the socket to a remote Bluetooth device. When the connect operation completes successfully, onReceive events are raised when data is received from the peer. If a network error occur while the runtime is receiving packets, a onReceiveError event is raised, at which point no more onReceive event will be raised for this socket until the setPaused(false) method is called.

|socket-id| - The socket identifier. |address| - The address of the Bluetooth device. |uuid| - The UUID of the service to connect to.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-connect.

connect* cljs

(connect* config socket-id address uuid)

create clj/s macro

(create)

(create properties)

Creates a Bluetooth socket.

|properties| - The socket properties (optional).

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [create-info] where:

|create-info| - The result of the socket creation.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-create.

create* cljs

(create* config properties)

disconnect clj/s macro

(disconnect socket-id)

Disconnects the socket. The socket identifier remains valid.

|socket-id| - The socket identifier.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-disconnect.

disconnect* cljs

(disconnect* config socket-id)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-info clj/s macro

(get-info socket-id)

Retrieves the state of the given socket.

|socket-id| - The socket identifier.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [socket-info] where:

|socket-info| - Object containing the socket information.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-getInfo.

get-info* cljs

(get-info* config socket-id)

get-sockets clj/s macro

(get-sockets)

Retrieves the list of currently opened sockets owned by the application.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [sockets] where:

|sockets| - https://developer.chrome.com/apps/bluetoothSocket#property-callback-sockets.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-getSockets.

get-sockets* cljs

(get-sockets* config)

listen-using-l2cap clj/s macro

(listen-using-l2cap socket-id uuid)

(listen-using-l2cap socket-id uuid options)

Listen for connections using the L2CAP protocol.

|socket-id| - The socket identifier. |uuid| - Service UUID to listen on. |options| - Optional additional options for the service.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-listenUsingL2cap.

listen-using-l2cap* cljs

(listen-using-l2cap* config socket-id uuid options)

listen-using-rfcomm clj/s macro

(listen-using-rfcomm socket-id uuid)

(listen-using-rfcomm socket-id uuid options)

Listen for connections using the RFCOMM protocol.

|socket-id| - The socket identifier. |uuid| - Service UUID to listen on. |options| - Optional additional options for the service.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-listenUsingRfcomm.

listen-using-rfcomm* cljs

(listen-using-rfcomm* config socket-id uuid options)

on-accept* cljs

(on-accept* config channel & args)

on-accept-error* cljs

(on-accept-error* config channel & args)

on-receive* cljs

(on-receive* config channel & args)

on-receive-error* cljs

(on-receive-error* config channel & args)

send clj/s macro

(send socket-id data)

Sends data on the given Bluetooth socket.

|socket-id| - The socket identifier. |data| - The data to send.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [bytes-sent] where:

|bytes-sent| - The number of bytes sent.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-send.

send* cljs

(send* config socket-id data)

set-paused clj/s macro

(set-paused socket-id paused)

Enables or disables a connected socket from receiving messages from its peer, or a listening socket from accepting new connections. The default value is 'false'. Pausing a connected socket is typically used by an application to throttle data sent by its peer. When a connected socket is paused, no onReceiveevent is raised. When a socket is connected and un-paused, onReceive events are raised again when messages are received. When a listening socket is paused, new connections are accepted until its backlog is full then additional connection requests are refused. onAccept events are raised only when the socket is un-paused.

|socket-id| - https://developer.chrome.com/apps/bluetoothSocket#property-setPaused-socketId. |paused| - https://developer.chrome.com/apps/bluetoothSocket#property-setPaused-paused.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-setPaused.

set-paused* cljs

(set-paused* config socket-id paused)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.bluetooth-socket namespace.

tap-on-accept-error-events clj/s macro

(tap-on-accept-error-events channel & args)

Event raised when a network error occurred while the runtime was waiting for new connections on the given socket. Once this event is raised, the socket is set to paused and no more onAccept events are raised for this socket.

Events will be put on the |channel| with signature [::on-accept-error [info]] where:

|info| - The event data.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/bluetoothSocket#event-onAcceptError.

tap-on-accept-events clj/s macro

(tap-on-accept-events channel & args)

Event raised when a connection has been established for a given socket.

Events will be put on the |channel| with signature [::on-accept [info]] where:

|info| - The event data.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/bluetoothSocket#event-onAccept.

tap-on-receive-error-events clj/s macro

(tap-on-receive-error-events channel & args)

Event raised when a network error occured while the runtime was waiting for data on the socket. Once this event is raised, the socket is set to paused and no more onReceive events are raised for this socket.

Events will be put on the |channel| with signature [::on-receive-error [info]] where:

|info| - The event data.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/bluetoothSocket#event-onReceiveError.

tap-on-receive-events clj/s macro

(tap-on-receive-events channel & args)

Event raised when data has been received for a given socket.

Events will be put on the |channel| with signature [::on-receive [info]] where:

|info| - The event data.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/bluetoothSocket#event-onReceive.

update clj/s macro

(update socket-id properties)

Updates the socket properties.

|socket-id| - The socket identifier. |properties| - The properties to update.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/bluetoothSocket#method-update.

update* cljs

(update* config socket-id properties)