upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
Data Structures | Functions | Enumerations
aci_cmds.h File Reference
Manufacturer » AdafruitSensor Categories » | Wireless CommunicationConnection Type » | AIOConnection Type » | GPIOConnection Type » | SPI » libupm-nrf8001 » aci-library » aci
Include dependency graph for aci_cmds.h:

API Description

Remarks

Go to the source code of this file.

Data Structures

struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 
struct  _aci_packed_
 Structure for the ACI_CMD_SET_LOCAL_DATA ACI command parameters. More...
 

Functions

 ACI_ASSERT_SIZE (aci_cmd_opcode_t, 1)
 
 ACI_ASSERT_SIZE (aci_cmd_params_test_t, 1)
 
 ACI_ASSERT_SIZE (aci_cmd_params_echo_t, ACI_ECHO_DATA_MAX_LEN)
 
 ACI_ASSERT_SIZE (aci_cmd_params_setup_t, 1)
 
 ACI_ASSERT_SIZE (aci_cmd_params_connect_t, 4)
 
 ACI_ASSERT_SIZE (aci_cmd_params_bond_t, 4)
 
 ACI_ASSERT_SIZE (aci_cmd_params_disconnect_t, 1)
 
 ACI_ASSERT_SIZE (aci_cmd_params_set_tx_power_t, 1)
 
 ACI_ASSERT_SIZE (aci_cmd_params_change_timing_t, 8)
 
 ACI_ASSERT_SIZE (aci_cmd_params_send_data_nack_t, 2)
 
 ACI_ASSERT_SIZE (aci_cmd_params_set_app_latency_t, 3)
 
 ACI_ASSERT_SIZE (aci_cmd_params_set_key_t, 17)
 

Enumerations

enum  _aci_packed_ {
  ACI_STORE_INVALID = 0x0, ACI_STORE_LOCAL = 0x01, ACI_STORE_REMOTE = 0x02, ACI_TX_BROADCAST = 0x0001,
  ACI_TX = 0x0002, ACI_TX_ACK = 0x0004, ACI_RX = 0x0008, ACI_RX_ACK = 0x0010,
  ACI_TX_REQ = 0x0020, ACI_RX_REQ = 0x0040, ACI_SET = 0x0080, ACI_TX_SIGN = 0x0100,
  ACI_RX_SIGN = 0x0200, ACI_RX_ACK_AUTO = 0x0400, ACI_BD_ADDR_TYPE_INVALID = 0x00, ACI_BD_ADDR_TYPE_PUBLIC = 0x01,
  ACI_BD_ADDR_TYPE_RANDOM_STATIC = 0x02, ACI_BD_ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE = 0x03, ACI_BD_ADDR_TYPE_RANDOM_PRIVATE_UNRESOLVABLE = 0x04, ACI_DEVICE_OUTPUT_POWER_MINUS_18DBM = 0x00,
  ACI_DEVICE_OUTPUT_POWER_MINUS_12DBM = 0x01, ACI_DEVICE_OUTPUT_POWER_MINUS_6DBM = 0x02, ACI_DEVICE_OUTPUT_POWER_0DBM = 0x03, ACI_DEVICE_INVALID =0x00,
  ACI_DEVICE_TEST =0x01, ACI_DEVICE_SETUP =0x02, ACI_DEVICE_STANDBY =0x03, ACI_DEVICE_SLEEP =0x04,
  ACI_REASON_TERMINATE =0x01, ACI_REASON_BAD_TIMING =0x02, ACI_TEST_MODE_DTM_UART = 0x01, ACI_TEST_MODE_DTM_ACI = 0x02,
  ACI_TEST_MODE_EXIT = 0xFF, ACI_PERMISSIONS_NONE =0x00, ACI_PERMISSIONS_LINK_AUTHENTICATED =0x01, ACI_HW_ERROR_NONE = 0x00,
  ACI_HW_ERROR_FATAL = 0x01, ACI_CLOCK_ACCURACY_500_PPM = 0x00, ACI_CLOCK_ACCURACY_250_PPM = 0x01, ACI_CLOCK_ACCURACY_150_PPM = 0x02,
  ACI_CLOCK_ACCURACY_100_PPM = 0x03, ACI_CLOCK_ACCURACY_75_PPM = 0x04, ACI_CLOCK_ACCURACY_50_PPM = 0x05, ACI_CLOCK_ACCURACY_30_PPM = 0x06,
  ACI_CLOCK_ACCURACY_20_PPM = 0x07, ACI_APP_LATENCY_DISABLE = 0, ACI_APP_LATENCY_ENABLE = 1, ACI_GATT_FORMAT_NONE = 0x00,
  ACI_GATT_FORMAT_BOOLEAN = 0x01, ACI_GATT_FORMAT_2BIT = 0x02, ACI_GATT_FORMAT_NIBBLE = 0x03, ACI_GATT_FORMAT_UINT8 = 0x04,
  ACI_GATT_FORMAT_UINT12 = 0x05, ACI_GATT_FORMAT_UINT16 = 0x06, ACI_GATT_FORMAT_UINT24 = 0x07, ACI_GATT_FORMAT_UINT32 = 0x08,
  ACI_GATT_FORMAT_UINT48 = 0x09, ACI_GATT_FORMAT_UINT64 = 0x0A, ACI_GATT_FORMAT_UINT128 = 0x0B, ACI_GATT_FORMAT_SINT8 = 0x0C,
  ACI_GATT_FORMAT_SINT12 = 0x0D, ACI_GATT_FORMAT_SINT16 = 0x0E, ACI_GATT_FORMAT_SINT24 = 0x0F, ACI_GATT_FORMAT_SINT32 = 0x10,
  ACI_GATT_FORMAT_SINT48 = 0x11, ACI_GATT_FORMAT_SINT64 = 0x12, ACI_GATT_FORMAT_SINT128 = 0x13, ACI_GATT_FORMAT_FLOAT32 = 0x14,
  ACI_GATT_FORMAT_FLOAT64 = 0x15, ACI_GATT_FORMAT_SFLOAT = 0x16, ACI_GATT_FORMAT_FLOAT = 0x17, ACI_GATT_FORMAT_DUINT16 = 0x18,
  ACI_GATT_FORMAT_UTF8S = 0x19, ACI_GATT_FORMAT_UTF16S = 0x1A, ACI_GATT_FORMAT_STRUCT = 0x1B, ACI_GATT_NAMESPACE_INVALID = 0x00,
  ACI_GATT_NAMESPACE_BTSIG = 0x01, ACI_KEY_TYPE_INVALID = 0x00, ACI_KEY_TYPE_PASSKEY = 0x01, ACI_BOND_STATUS_SUCCESS = 0x00,
  ACI_BOND_STATUS_FAILED = 0x01, ACI_BOND_STATUS_FAILED_TIMED_OUT = 0x02, ACI_BOND_STATUS_FAILED_PASSKEY_ENTRY_FAILED = 0x81, ACI_BOND_STATUS_FAILED_OOB_UNAVAILABLE = 0x82,
  ACI_BOND_STATUS_FAILED_AUTHENTICATION_REQ = 0x83, ACI_BOND_STATUS_FAILED_CONFIRM_VALUE = 0x84, ACI_BOND_STATUS_FAILED_PAIRING_UNSUPPORTED = 0x85, ACI_BOND_STATUS_FAILED_ENCRYPTION_KEY_SIZE = 0x86,
  ACI_BOND_STATUS_FAILED_SMP_CMD_UNSUPPORTED = 0x87, ACI_BOND_STATUS_FAILED_UNSPECIFIED_REASON = 0x88, ACI_BOND_STATUS_FAILED_REPEATED_ATTEMPTS = 0x89, ACI_BOND_STATUS_FAILED_INVALID_PARAMETERS = 0x8A,
  ACI_BOND_STATUS_SOURCE_INVALID = 0x00, ACI_BOND_STATUS_SOURCE_LOCAL = 0x01, ACI_BOND_STATUS_SOURCE_REMOTE = 0x02, ACI_STATUS_SUCCESS = 0x00,
  ACI_STATUS_TRANSACTION_CONTINUE = 0x01, ACI_STATUS_TRANSACTION_COMPLETE = 0x02, ACI_STATUS_EXTENDED = 0x03, ACI_STATUS_ERROR_UNKNOWN = 0x80,
  ACI_STATUS_ERROR_INTERNAL = 0x81, ACI_STATUS_ERROR_CMD_UNKNOWN = 0x82, ACI_STATUS_ERROR_DEVICE_STATE_INVALID = 0x83, ACI_STATUS_ERROR_INVALID_LENGTH = 0x84,
  ACI_STATUS_ERROR_INVALID_PARAMETER = 0x85, ACI_STATUS_ERROR_BUSY = 0x86, ACI_STATUS_ERROR_INVALID_DATA = 0x87, ACI_STATUS_ERROR_CRC_MISMATCH = 0x88,
  ACI_STATUS_ERROR_UNSUPPORTED_SETUP_FORMAT = 0x89, ACI_STATUS_ERROR_INVALID_SEQ_NO = 0x8A, ACI_STATUS_ERROR_SETUP_LOCKED = 0x8B, ACI_STATUS_ERROR_LOCK_FAILED = 0x8C,
  ACI_STATUS_ERROR_BOND_REQUIRED = 0x8D, ACI_STATUS_ERROR_REJECTED = 0x8E, ACI_STATUS_ERROR_DATA_SIZE = 0x8F, ACI_STATUS_ERROR_PIPE_INVALID = 0x90,
  ACI_STATUS_ERROR_CREDIT_NOT_AVAILABLE = 0x91, ACI_STATUS_ERROR_PEER_ATT_ERROR = 0x92, ACI_STATUS_ERROR_ADVT_TIMEOUT = 0x93, ACI_STATUS_ERROR_PEER_SMP_ERROR = 0x94,
  ACI_STATUS_ERROR_PIPE_TYPE_INVALID = 0x95, ACI_STATUS_ERROR_PIPE_STATE_INVALID = 0x96, ACI_STATUS_ERROR_INVALID_KEY_SIZE = 0x97, ACI_STATUS_ERROR_INVALID_KEY_DATA = 0x98,
  ACI_STATUS_RESERVED_START = 0xF0, ACI_STATUS_RESERVED_END = 0xFF, ACI_CMD_TEST = 0x01, ACI_CMD_ECHO = 0x02,
  ACI_CMD_DTM_CMD = 0x03, ACI_CMD_SLEEP = 0x04, ACI_CMD_WAKEUP = 0x05, ACI_CMD_SETUP = 0x06,
  ACI_CMD_READ_DYNAMIC_DATA = 0x07, ACI_CMD_WRITE_DYNAMIC_DATA = 0x08, ACI_CMD_GET_DEVICE_VERSION = 0x09, ACI_CMD_GET_DEVICE_ADDRESS = 0x0A,
  ACI_CMD_GET_BATTERY_LEVEL = 0x0B, ACI_CMD_GET_TEMPERATURE = 0x0C, ACI_CMD_SET_LOCAL_DATA = 0x0D, ACI_CMD_RADIO_RESET = 0x0E,
  ACI_CMD_CONNECT = 0x0F, ACI_CMD_BOND = 0x10, ACI_CMD_DISCONNECT = 0x11, ACI_CMD_SET_TX_POWER = 0x12,
  ACI_CMD_CHANGE_TIMING = 0x13, ACI_CMD_OPEN_REMOTE_PIPE = 0x14, ACI_CMD_SEND_DATA = 0x15, ACI_CMD_SEND_DATA_ACK = 0x16,
  ACI_CMD_REQUEST_DATA = 0x17, ACI_CMD_SEND_DATA_NACK = 0x18, ACI_CMD_SET_APP_LATENCY = 0x19, ACI_CMD_SET_KEY = 0x1A,
  ACI_CMD_OPEN_ADV_PIPE = 0x1B, ACI_CMD_BROADCAST = 0x1C, ACI_CMD_BOND_SECURITY_REQUEST = 0x1D, ACI_CMD_CONNECT_DIRECT = 0x1E,
  ACI_CMD_CLOSE_REMOTE_PIPE = 0x1F, ACI_CMD_INVALID = 0xFF, ACI_EVT_INVALID = 0x00, ACI_EVT_DEVICE_STARTED = 0x81,
  ACI_EVT_ECHO = 0x82, ACI_EVT_HW_ERROR = 0x83, ACI_EVT_CMD_RSP = 0x84, ACI_EVT_CONNECTED = 0x85,
  ACI_EVT_DISCONNECTED = 0x86, ACI_EVT_BOND_STATUS = 0x87, ACI_EVT_PIPE_STATUS = 0x88, ACI_EVT_TIMING = 0x89,
  ACI_EVT_DATA_CREDIT = 0x8A, ACI_EVT_DATA_ACK = 0x8B, ACI_EVT_DATA_RECEIVED = 0x8C, ACI_EVT_PIPE_ERROR = 0x8D,
  ACI_EVT_DISPLAY_PASSKEY = 0x8E, ACI_EVT_KEY_REQUEST = 0x8F
}
 

Enumeration Type Documentation

enum _aci_packed_
Enumerator
ACI_DEVICE_OUTPUT_POWER_MINUS_18DBM 

Output power set to -18dBm

ACI_DEVICE_OUTPUT_POWER_MINUS_12DBM 

Output power set to -12dBm

ACI_DEVICE_OUTPUT_POWER_MINUS_6DBM 

Output power set to -6dBm

ACI_DEVICE_OUTPUT_POWER_0DBM 

Output power set to 0dBm - DEFAULT

ACI_REASON_TERMINATE 

Use this to disconnect (does a terminate request), you need to wait for the "disconnected" event

ACI_GATT_FORMAT_NONE 

No characteristic format available

ACI_GATT_FORMAT_BOOLEAN 

Not Supported

ACI_GATT_FORMAT_2BIT 

Not Supported

ACI_GATT_FORMAT_NIBBLE 

Not Supported

ACI_GATT_NAMESPACE_BTSIG 

Bluetooth SIG

ACI_BOND_STATUS_SUCCESS 

Bonding succeeded

ACI_BOND_STATUS_FAILED 

Bonding failed

ACI_BOND_STATUS_FAILED_TIMED_OUT 

Bonding error: Timeout can occur when link termination is unexpected or did not get connected OR SMP timer expired

ACI_BOND_STATUS_FAILED_PASSKEY_ENTRY_FAILED 

Bonding error: Passkey entry failed

ACI_BOND_STATUS_FAILED_OOB_UNAVAILABLE 

Bonding error: OOB unavailable

ACI_BOND_STATUS_FAILED_AUTHENTICATION_REQ 

Bonding error: Authentication request failed

ACI_BOND_STATUS_FAILED_CONFIRM_VALUE 

Bonding error: Confirm value failed

ACI_BOND_STATUS_FAILED_PAIRING_UNSUPPORTED 

Bonding error: Pairing unsupported

ACI_BOND_STATUS_FAILED_ENCRYPTION_KEY_SIZE 

Bonding error: Invalid encryption key size

ACI_BOND_STATUS_FAILED_SMP_CMD_UNSUPPORTED 

Bonding error: Unsupported SMP command

ACI_BOND_STATUS_FAILED_UNSPECIFIED_REASON 

Bonding error: Unspecified reason

ACI_BOND_STATUS_FAILED_REPEATED_ATTEMPTS 

Bonding error: Too many attempts

ACI_BOND_STATUS_FAILED_INVALID_PARAMETERS 

Bonding error: Invalid parameters

ACI_STATUS_SUCCESS 

Success

ACI_STATUS_TRANSACTION_CONTINUE 

Transaction continuation status

ACI_STATUS_TRANSACTION_COMPLETE 

Transaction completed

ACI_STATUS_EXTENDED 

Extended status, further checks needed

ACI_STATUS_ERROR_UNKNOWN 

Unknown error.

ACI_STATUS_ERROR_INTERNAL 

Internal error.

ACI_STATUS_ERROR_CMD_UNKNOWN 

Unknown command

ACI_STATUS_ERROR_DEVICE_STATE_INVALID 

Command invalid in the current device state

ACI_STATUS_ERROR_INVALID_LENGTH 

Invalid length

ACI_STATUS_ERROR_INVALID_PARAMETER 

Invalid input parameters

ACI_STATUS_ERROR_BUSY 

Busy

ACI_STATUS_ERROR_INVALID_DATA 

Invalid data format or contents

ACI_STATUS_ERROR_CRC_MISMATCH 

CRC mismatch

ACI_STATUS_ERROR_UNSUPPORTED_SETUP_FORMAT 

Unsupported setup format

ACI_STATUS_ERROR_INVALID_SEQ_NO 

Invalid sequence number during a write dynamic data sequence

ACI_STATUS_ERROR_SETUP_LOCKED 

Setup data is locked and cannot be modified

ACI_STATUS_ERROR_LOCK_FAILED 

Setup error due to lock verification failure

ACI_STATUS_ERROR_BOND_REQUIRED 

Bond required: Local Pipes need bonded/trusted peer

ACI_STATUS_ERROR_REJECTED 

Command rejected as a transaction is still pending

ACI_STATUS_ERROR_DATA_SIZE 

Pipe Error Event : Data size exceeds size specified for pipe : Transmit failed

ACI_STATUS_ERROR_PIPE_INVALID 

Pipe Error Event : Invalid pipe

ACI_STATUS_ERROR_CREDIT_NOT_AVAILABLE 

Pipe Error Event : Credit not available

ACI_STATUS_ERROR_PEER_ATT_ERROR 

Pipe Error Event : Peer device has sent an error on an pipe operation on the remote characteristic

ACI_STATUS_ERROR_ADVT_TIMEOUT 

Connection was not established before the BTLE advertising was stopped

ACI_STATUS_ERROR_PEER_SMP_ERROR 

Peer has triggered a Security Manager Protocol Error

ACI_STATUS_ERROR_PIPE_TYPE_INVALID 

Pipe Error Event : Pipe type invalid for the selected operation

ACI_STATUS_ERROR_PIPE_STATE_INVALID 

Pipe Error Event : Pipe state invalid for the selected operation

ACI_STATUS_ERROR_INVALID_KEY_SIZE 

Invalid key size provided

ACI_STATUS_ERROR_INVALID_KEY_DATA 

Invalid key data provided

ACI_STATUS_RESERVED_START 

Reserved range start

ACI_STATUS_RESERVED_END 

Reserved range end

ACI_CMD_TEST 

Enter test mode

ACI_CMD_ECHO 

Echo (loopback) test command

ACI_CMD_DTM_CMD 

Send a BTLE DTM command to the radio

ACI_CMD_SLEEP 

Put the device to sleep

ACI_CMD_WAKEUP 

Wakeup the device from deep sleep

ACI_CMD_SETUP 

Replace the contents of the internal database with user provided data

ACI_CMD_READ_DYNAMIC_DATA 

Read the portions of memory required to be restored after a power cycle

ACI_CMD_WRITE_DYNAMIC_DATA 

Write back the data retrieved using ACI_CMD_READ_DYNAMIC_DATA

ACI_CMD_GET_DEVICE_VERSION 

Retrieve the device's version information

ACI_CMD_GET_DEVICE_ADDRESS 

Request the Bluetooth address and its type

ACI_CMD_GET_BATTERY_LEVEL 

Request the battery level measured by nRF8001

ACI_CMD_GET_TEMPERATURE 

Request the temperature value measured by nRF8001

ACI_CMD_SET_LOCAL_DATA 

Write to the local Attribute Database

ACI_CMD_RADIO_RESET 

Reset the baseband and radio and go back to idle

ACI_CMD_CONNECT 

Start advertising and wait for a master connection

ACI_CMD_BOND 

Start advertising and wait for a master connection

ACI_CMD_DISCONNECT 

Start advertising and wait for a master connection

ACI_CMD_SET_TX_POWER 

Throttles the Radio transmit power

ACI_CMD_CHANGE_TIMING 

Trigger a connection parameter update

ACI_CMD_OPEN_REMOTE_PIPE 

Open a remote pipe for data reception

ACI_CMD_SEND_DATA 

Transmit data over an open pipe

ACI_CMD_SEND_DATA_ACK 

Send an acknowledgment of received data

ACI_CMD_REQUEST_DATA 

Request data over an open pipe

ACI_CMD_SEND_DATA_NACK 

NACK a data reception

ACI_CMD_SET_APP_LATENCY 

Set application latency

ACI_CMD_SET_KEY 

Set a security key

ACI_CMD_OPEN_ADV_PIPE 

Open Advertising Pipes

ACI_CMD_BROADCAST 

Start non-connectable advertising

ACI_CMD_BOND_SECURITY_REQUEST 

Start a security request in bonding mode

ACI_CMD_CONNECT_DIRECT 

Start Directed advertising towards a Bonded Peer

ACI_CMD_CLOSE_REMOTE_PIPE 

Close a previously opened remote pipe

ACI_CMD_INVALID 

Invalid ACI command opcode

ACI_EVT_INVALID 

Invalid event code

ACI_EVT_DEVICE_STARTED 

Sent every time the device starts

ACI_EVT_ECHO 

Mirrors the ACI_CMD_ECHO

ACI_EVT_HW_ERROR 

Asynchronous hardware error event

ACI_EVT_CMD_RSP 

Event opcode used as a event response for all commands

ACI_EVT_CONNECTED 

Link connected

ACI_EVT_DISCONNECTED 

Link disconnected

ACI_EVT_BOND_STATUS 

Bond completion result

ACI_EVT_PIPE_STATUS 

Pipe bitmap for available pipes

ACI_EVT_TIMING 

Sent to the application when the radio enters a connected state or when the timing of the radio connection changes

ACI_EVT_DATA_CREDIT 

Notification to the application that transmit credits are available

ACI_EVT_DATA_ACK 

Data acknowledgement event

ACI_EVT_DATA_RECEIVED 

Data received notification event

ACI_EVT_PIPE_ERROR 

Error notification event

ACI_EVT_DISPLAY_PASSKEY 

Display Passkey Event

ACI_EVT_KEY_REQUEST 

Security Key request

Generated on Wed Nov 21 2018 10:43:54 for upm by   doxygen 1.8.11