blatann.nrf.nrf_types package

exception blatann.nrf.nrf_types.NordicSemiException(msg, error_code=None)

Bases: Exception

Exception used as based exception for other exceptions defined in this package.

class blatann.nrf.nrf_types.BleConnConfig(conn_tag=1, conn_count=1, event_length=3, write_cmd_tx_queue_size=1, hvn_tx_queue_size=1, max_att_mtu=23)

Bases: object

DEFAULT_CONN_TAG = 1
get_gap_config()
get_gatt_config()
get_gattc_config()
get_gatts_config()
get_configs()
class blatann.nrf.nrf_types.BleEnableConfig(vs_uuid_count=10, periph_role_count=1, central_role_count=3, central_sec_count=3, service_changed_char=1, attr_table_size=1408)

Bases: object

get_vs_uuid_cfg()
get_role_count_cfg()
get_device_name_cfg()
get_service_changed_cfg()
get_attr_tab_size_cfg()
get_configs()
class blatann.nrf.nrf_types.BleEnableOpt(enabled=False)

Bases: BleOption

to_c()
class blatann.nrf.nrf_types.BleOptConnEventExtension(enabled=False)

Bases: BleEnableOpt

option_flag = 2
path = 'common_opt.conn_evt_ext'
class blatann.nrf.nrf_types.BleOptGapAuthPayloadTimeout(conn_handle, timeout_ms=48000)

Bases: BleOption

option_flag = 37
path = 'gap_opt.auth_payload_timeout'
to_c()
class blatann.nrf.nrf_types.BleOptGapChannelMap(enabled_channels=None, conn_handle=0)

Bases: BleOption

option_flag = 32
path = 'gap_opt.ch_map'
to_c()
class blatann.nrf.nrf_types.BleOptGapCompatMode1(enabled=False)

Bases: BleEnableOpt

option_flag = 36
path = 'gap_opt.compat_mode_q'
class blatann.nrf.nrf_types.BleOptGapLocalConnLatency(conn_handle=0, requested_latency=0)

Bases: BleOption

option_flag = 33
path = 'gap_opt.local_conn_latency'
to_c()
class blatann.nrf.nrf_types.BleOptGapPasskey(passkey='000000')

Bases: BleOption

option_flag = 34
path = 'gap_opt.passkey'
to_c()
class blatann.nrf.nrf_types.BleOptGapScanRequestReport(enabled=False)

Bases: BleEnableOpt

option_flag = 35
path = 'gap_opt.scan_req_report'
class blatann.nrf.nrf_types.BleOptGapSlaveLatencyDisable(conn_handle, disabled=False)

Bases: BleOption

option_flag = 38
path = 'gap_opt.slave_latency_disable'
to_c()
class blatann.nrf.nrf_types.BleOption

Bases: object

option_flag = None
path = ''
to_c()
class blatann.nrf.nrf_types.BleOptionFlag(value)

Bases: IntEnum

An enumeration.

pa_lna = 1
conn_event_extension = 2
gap_channel_map = 32
gap_local_conn_latency = 33
gap_passkey = 34
gap_scan_req_report = 35
gap_compat_mode_1 = 36
gap_auth_payload_timeout = 37
gap_slave_latency_disable = 38
class blatann.nrf.nrf_types.BleOptPaLna(pa_config=None, lna_cfg=None, ppi_channel_set=0, ppi_channel_clear=0, gpiote_channel=0)

Bases: BleOption

option_flag = 1
path = 'common_opt.pa_lna'
to_c()
class blatann.nrf.nrf_types.BlePaLnaConfig(enabled=False, active_high=True, pin=0)

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGapAdvType(value)

Bases: IntEnum

An enumeration.

connectable_undirected = 0
connectable_directed = 1
scanable_undirected = 2
non_connectable_undirected = 3
scan_response = 4
class blatann.nrf.nrf_types.BLEGapAuthKeyType(value)

Bases: IntEnum

An enumeration.

NONE = 0
OOB = 2
PASSKEY = 1
class blatann.nrf.nrf_types.BLEGapIoCaps(value)

Bases: IntEnum

An enumeration.

DISPLAY_ONLY = 0
DISPLAY_YESNO = 1
KEYBOARD_ONLY = 2
NONE = 3
KEYBOARD_DISPLAY = 4
class blatann.nrf.nrf_types.BLEGapPhy(value)

Bases: IntFlag

An enumeration.

auto = 0
one_mbps = 1
two_mbps = 2
coded = 4
class blatann.nrf.nrf_types.BLEGapRoles(value)

Bases: IntEnum

An enumeration.

invalid = 0
periph = 1
central = 2
class blatann.nrf.nrf_types.BLEGapSecStatus(value)

Bases: IntEnum

An enumeration.

success = 0
timeout = 1
pdu_invalid = 2
passkey_entry_failed = 129
oob_not_available = 130
auth_req = 131
confirm_value = 132
pairing_not_supp = 133
enc_key_size = 134
smp_cmd_unsupported = 135
unspecified = 136
repeated_attempts = 137
invalid_params = 138
dhkey_failure = 139
num_comp_failure = 140
br_edr_in_prog = 141
x_trans_key_disallowed = 142
class blatann.nrf.nrf_types.BLEGapTimeoutSrc(value)

Bases: IntEnum

An enumeration.

advertising = 0
scan = 1
conn = 2
security_req = 3
class blatann.nrf.nrf_types.BLEGattExecWriteFlag(value)

Bases: Enum

An enumeration.

prepared_cancel = 0
prepared_write = 1
unused = 0
class blatann.nrf.nrf_types.BLEGattHVXType(value)

Bases: Enum

An enumeration.

invalid = 0
notification = 1
indication = 2
class blatann.nrf.nrf_types.BLEGattStatusCode(value)

Bases: Enum

An enumeration.

success = 0
unknown = 1
invalid = 256
invalid_handle = 257
read_not_permitted = 258
write_not_permitted = 259
invalid_pdu = 260
insuf_authentication = 261
request_not_supported = 262
invalid_offset = 263
insuf_authorization = 264
prepare_queue_full = 265
attribute_not_found = 266
attribute_not_long = 267
insuf_enc_key_size = 268
invalid_att_val_length = 269
unlikely_error = 270
insuf_encryption = 271
unsupported_group_type = 272
insuf_resources = 273
rfu_range1_begin = 274
rfu_range1_end = 383
app_begin = 384
app_end = 415
rfu_range2_begin = 416
rfu_range2_end = 479
rfu_range3_begin = 480
rfu_range3_end = 508
cps_cccd_config_error = 509
cps_proc_alr_in_prog = 510
cps_out_of_range = 511
class blatann.nrf.nrf_types.BLEGattsWriteOperation(value)

Bases: Enum

An enumeration.

invalid = 0
write_req = 1
write_cmd = 2
sign_write_cmd = 3
prep_write_req = 4
exec_write_req_cancel = 5
exec_write_req_now = 6
class blatann.nrf.nrf_types.BLEGattWriteOperation(value)

Bases: Enum

An enumeration.

invalid = 0
write_req = 1
write_cmd = 2
signed_write_cmd = 3
prepare_write_req = 4
execute_write_req = 5
class blatann.nrf.nrf_types.BLEHci(value)

Bases: Enum

An enumeration.

success = 0
unknown_btle_command = 1
unknown_connection_identifier = 2
authentication_failure = 5
pin_or_key_missing = 6
memory_capacity_exceeded = 7
connection_timeout = 8
command_disallowed = 12
invalid_btle_command_parameters = 18
remote_user_terminated_connection = 19
remote_dev_termination_due_to_low_resources = 20
remote_dev_termination_due_to_power_off = 21
local_host_terminated_connection = 22
unsupported_remote_feature = 26
invalid_lmp_parameters = 30
unspecified_error = 31
lmp_response_timeout = 34
lmp_transaction_collision = 35
lmp_pdu_not_allowed = 36
instant_passed = 40
pairintg_with_unit_key_unsupported = 41
differen_transaction_collision = 42
controller_busy = 58
conn_interval_unacceptable = 59
parameter_out_of_mandatory_range = 48
directed_advertiser_timeout = 60
conn_terminated_due_to_mic_failure = 61
conn_failed_to_be_established = 62
class blatann.nrf.nrf_types.NrfError(value)

Bases: Enum

An enumeration.

success = 0
svc_handler_missing = 1
softdevice_not_enabled = 2
internal = 3
no_mem = 4
not_found = 5
not_supported = 6
invalid_param = 7
invalid_state = 8
invalid_length = 9
invalid_flags = 10
invalid_data = 11
data_size = 12
timeout = 13
null = 14
forbidden = 15
invalid_addr = 16
busy = 17
conn_count = 18
resources = 19
ble_not_enabled = 12289
ble_invalid_conn_handle = 12290
ble_invalid_attr_handle = 12291
ble_invalid_adv_handle = 12292
ble_invalid_role = 12293
ble_gap_uuid_list_mismatch = 12800
ble_gap_discoverable_with_whitelist = 12801
ble_gap_invalid_ble_addr = 12802
ble_gap_whitelist_in_use = 12803
ble_gap_device_identities_in_use = 12804
ble_gap_device_identities_duplicate = 12805
ble_gattc_proc_not_permitted = 13056
ble_gatts_invalid_attr_type = 13312
ble_gatts_sys_attr_missing = 13313
rpc_encode = 32769
rpc_decode = 32770
rpc_send = 32771
rpc_invalid_argument = 32772
rpc_no_response = 32773
rpc_invalid_state = 32774
rpc_serialization_transport = 32788
rpc_serialization_transport_invalid_state = 32789
rpc_serialization_transport_no_response = 32790
rpc_serialization_transport_already_open = 32791
rpc_serialization_transport_already_closed = 32792
rpc_h5_transport = 32808
rpc_h5_transport_state = 32809
rpc_h5_transport_no_response = 32810
rpc_h5_transport_slip_payload_size = 32811
rpc_h5_transport_slip_calculated_payload_size = 32812
rpc_h5_transport_slip_decoding = 32813
rpc_h5_transport_header_checksum = 32814
rpc_h5_transport_packet_checksum = 32815
rpc_h5_transport_already_open = 32816
rpc_h5_transport_already_closed = 32817
rpc_h5_transport_internal_error = 32818
rpc_serial_port = 32828
rpc_serial_port_state = 32829
rpc_serial_port_already_open = 32830
rpc_serial_port_already_closed = 32831
rpc_serial_port_internal_error = 32832
class blatann.nrf.nrf_types.BLEAdvData(**kwargs)

Bases: object

class Types(value)

Bases: Enum

An enumeration.

flags = 1
service_16bit_uuid_more_available = 2
service_16bit_uuid_complete = 3
service_32bit_uuid_more_available = 4
service_32bit_uuid_complete = 5
service_128bit_uuid_more_available = 6
service_128bit_uuid_complete = 7
short_local_name = 8
complete_local_name = 9
tx_power_level = 10
class_of_device = 13
simple_pairing_hash_c = 14
simple_pairing_randimizer_r = 15
security_manager_tk_value = 16
security_manager_oob_flags = 17
slave_connection_interval_range = 18
solicited_sevice_uuids_16bit = 20
solicited_sevice_uuids_128bit = 21
service_data = 22
public_target_address = 23
random_target_address = 24
appearance = 25
advertising_interval = 26
le_bluetooth_device_address = 27
le_role = 28
simple_pairng_hash_c256 = 29
simple_pairng_randomizer_r256 = 30
service_data_32bit_uuid = 32
service_data_128bit_uuid = 33
uri = 36
information_3d_data = 61
manufacturer_specific_data = 255
to_list()
to_c()
classmethod from_c(adv_report_evt)
class blatann.nrf.nrf_types.BLEGapAddr(addr_type, addr)

Bases: object

classmethod from_c(addr)
classmethod from_string(addr_string)
to_c()
get_addr_type_str()
get_addr_flag()
class blatann.nrf.nrf_types.BLEGapAddrTypes(value)

Bases: IntEnum

An enumeration.

public = 0
random_static = 1
random_private_resolvable = 2
random_private_non_resolvable = 3
anonymous = 127
class blatann.nrf.nrf_types.BLEGapAdvParams(interval_ms, timeout_s, advertising_type=BLEGapAdvType.connectable_undirected, channel_mask=None)

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGapConnParams(min_conn_interval_ms, max_conn_interval_ms, conn_sup_timeout_ms, slave_latency)

Bases: object

validate()
classmethod from_c(conn_params)
to_c()
class blatann.nrf.nrf_types.BLEGapDataLengthParams(max_tx_octets=0, max_rx_octets=0, max_tx_time_us=0, max_rx_time_us=0)

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGapPhys(tx_phys=<BLEGapPhy.auto: 0>, rx_phys=<BLEGapPhy.auto: 0>)

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGapPrivacyParams(enabled=False, resolvable_addr=False, addr_update_rate_s=900)

Bases: object

DEFAULT_PRIVATE_ADDR_CYCLE_INTERVAL_S = 900
to_c()
classmethod from_c(privacy)
class blatann.nrf.nrf_types.BLEGapScanParams(interval_ms, window_ms, timeout_s, active=True)

Bases: object

to_c()
class blatann.nrf.nrf_types.TimeRange(name, val_min, val_max, unit_ms_conversion, divisor=1.0, units='ms')

Bases: object

property name: str
property min: float
property max: float
property units: str
is_in_range(value)
validate(value)
class blatann.nrf.nrf_types.BLEGattcAttrInfo128(attr_handle, uuid)

Bases: object

classmethod from_c(attr_info128)
class blatann.nrf.nrf_types.BLEGattcAttrInfo16(handle, uuid)

Bases: object

classmethod from_c(attr_info16)
class blatann.nrf.nrf_types.BLEGattcDescriptor(uuid, handle, data=None)

Bases: object

classmethod from_c(gattc_desc)
class blatann.nrf.nrf_types.BLEGattCharacteristic(uuid, handle_decl, handle_value, data_decl=None, data_value=None, char_props=None)

Bases: object

char_uuid = 0x2803 (Standard.characteristic)
discovered_handles()
missing_handles()
classmethod from_c(gattc_char)
class blatann.nrf.nrf_types.BLEGattCharacteristicProperties(broadcast=False, read=False, write_wo_resp=False, write=False, notify=False, indicate=False, auth_signed_wr=False)

Bases: object

classmethod from_c(gattc_char_props)
to_c()
class blatann.nrf.nrf_types.BLEGattcWriteParams(write_op, flags, handle, data, offset)

Bases: object

classmethod from_c(gattc_write_params)
to_c()
class blatann.nrf.nrf_types.BLEGattExtendedCharacteristicProperties(reliable_write=False, writable_aux=False)

Bases: object

to_c()
classmethod from_c(params)
class blatann.nrf.nrf_types.BleGattHandle(handle=0)

Bases: object

class blatann.nrf.nrf_types.BLEGattsAttribute(uuid, attr_metadata, max_len, value=b'')

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGattsAttrMetadata(read_permissions=<blatann.nrf.nrf_types.smp.BLEGapSecMode object>, write_permissions=<blatann.nrf.nrf_types.smp.BLEGapSecMode object>, variable_length=False, read_auth=False, write_auth=False)

Bases: object

to_c()
classmethod from_c(params)
class blatann.nrf.nrf_types.BLEGattsAuthorizeParams(gatt_status, update, offset=0, data='')

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGattsCharHandles(value_handle=0, user_desc_handle=0, cccd_handle=0, sccd_handle=0)

Bases: object

to_c()
classmethod from_c(handle_params)
class blatann.nrf.nrf_types.BLEGattsCharMetadata(char_props, user_description='', user_description_max_size=0, user_desc_metadata=None, cccd_metadata=None, sccd_metadata=None, presentation_format=None)

Bases: object

to_c()
classmethod from_c(params)
class blatann.nrf.nrf_types.BLEGattService(uuid, start_handle, end_handle)

Bases: object

srvc_uuid = 0x2800 (Standard.service_primary)
classmethod from_c(gattc_service)
char_add(char)
class blatann.nrf.nrf_types.BLEGattsHvx(char_handle, hvx_type, data, offset=0)

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGattsPresentationFormat(fmt, exponent, unit, namespace, description)

Bases: object

to_c()
classmethod from_c(params)
class blatann.nrf.nrf_types.BLEGattsRwAuthorizeReplyParams(read=None, write=None)

Bases: object

to_c()
class blatann.nrf.nrf_types.BLEGattsValue(value, offset=0)

Bases: object

to_c()
classmethod from_c(params)
class blatann.nrf.nrf_types.BLEUUID(value, base=<blatann.nrf.nrf_types.generic.BLEUUIDBase object>)

Bases: object

class Standard(value)

Bases: Enum

An enumeration.

unknown = 0
service_primary = 10240
service_secondary = 10241
characteristic = 10243
cccd = 10498
battery_level = 10777
heart_rate = 10807
get_value()
as_array()
classmethod from_c(uuid)
classmethod from_uuid128(uuid128)
to_c()
classmethod from_array(uuid_array_lt)
class blatann.nrf.nrf_types.BLEUUIDBase(vs_uuid_base=None, uuid_type=None)

Bases: object

BLE_UUID_TYPE_BLE = 1
classmethod from_c(uuid)
classmethod from_uuid128_array(uuid128_array)
to_c()
class blatann.nrf.nrf_types.BLEGapDhKey(key=b'')

Bases: object

KEY_LENGTH = 32
to_c()
classmethod from_c(key)
class blatann.nrf.nrf_types.BLEGapEncryptInfo(ltk=b'', lesc=False, auth=False)

Bases: object

KEY_LENGTH = 16
to_c()
classmethod from_c(info)
to_dict()
classmethod from_dict(data)
class blatann.nrf.nrf_types.BLEGapEncryptKey(enc_info=None, master_id=None)

Bases: object

to_c()
classmethod from_c(key)
to_dict()
classmethod from_dict(data)
class blatann.nrf.nrf_types.BLEGapIdKey(irk=b'', peer_addr=None)

Bases: object

KEY_LENGTH = 16
to_c()
classmethod from_c(id_key)
to_dict()
classmethod from_dict(data)
class blatann.nrf.nrf_types.BLEGapMasterId(ediv=0, rand=b'')

Bases: object

RAND_LEN = 8
RAND_INVALID = b'\x00\x00\x00\x00\x00\x00\x00\x00'
to_c()
property is_valid: bool
classmethod from_c(master_id)
to_dict()
classmethod from_dict(data)
class blatann.nrf.nrf_types.BLEGapPublicKey(key=b'')

Bases: object

KEY_LENGTH = 64
to_c()
classmethod from_c(key)
class blatann.nrf.nrf_types.BLEGapSecKeyDist(enc_key=False, id_key=False, sign_key=False, link_key=False)

Bases: object

classmethod from_c(kdist)
to_c()
class blatann.nrf.nrf_types.BLEGapSecKeys(enc_key=None, id_key=None, sign_key=None, public_key=None)

Bases: object

to_c()
classmethod from_c(keys)
class blatann.nrf.nrf_types.BLEGapSecKeyset(own_keys=None, peer_keys=None)

Bases: object

to_c()
reload()
classmethod from_c(keyset)
class blatann.nrf.nrf_types.BLEGapSecLevels(lv1, lv2, lv3, lv4)

Bases: object

classmethod from_c(sec_level)
to_c()
class blatann.nrf.nrf_types.BLEGapSecMode(sec_mode, level)

Bases: object

to_c()
classmethod from_c(params)
class blatann.nrf.nrf_types.BLEGapSecModeType

Bases: object

NO_ACCESS = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
OPEN = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
ENCRYPTION = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
MITM = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
LESC_MITM = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
SIGN_OR_ENCRYPT = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
SIGN_OR_ENCRYPT_MITM = <blatann.nrf.nrf_types.smp.BLEGapSecMode object>
class blatann.nrf.nrf_types.BLEGapSecParams(bond, mitm, le_sec_pairing, keypress_noti, io_caps, oob, min_key_size, max_key_size, kdist_own, kdist_peer)

Bases: object

classmethod from_c(sec_params)
to_c()
class blatann.nrf.nrf_types.BLEGapSignKey(key=b'')

Bases: object

KEY_LENGTH = 16
to_c()
classmethod from_c(key)
to_dict()
classmethod from_dict(data)

Submodules