Peripherals

identifier(peripheral)

Get the name of a peripheral.

See also address(::Peripheral)

address(peripheral)

Get the address of a peripheral.

See also identifier(::Peripheral)

address_type(peripheral)

rssi(peripheral)

tx_power(peripheral)

mtu(peripheral)

connect(peripheral)

Connect to a peripheral. Generally you should disconnect when you're done with it

connect(callback, peripheral)
connect(peripheral) do
	# Stuff
end

Convenience function for automatically disconnecting from a peripheral once you're done with it

disconnect(peripheral)

is_connected(peripheral)

is_connectable(peripheral)

is_paired(peripheral)

unpair(peripheral)

services(peripheral)

Acquire the services provided by a peripheral.

manufacturer_data(peripheral)

Acquire the manufacturer data associated with peripheral.

peripheral_read(peripheral, 
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC},
)

Read data from a characteristic.

service and characteristic can be AbstractStrings, SBLEUUIDs, or SBLESERVICE and SBLECHARACTERISTIC acquired by services.

write_request(peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC},
	data <: Union{AbstractString, AbstractArray}
)

Write a request to a characteristic.

See also write_command

write_command(
	peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC},
	data <: Union{AbstractString, AbstractArray}
)

Write a command to a characteristic.

See also write_request

notify(callback,
	peripheral::Peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC}
)
notify(
	peripheral::Peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC}
) do data
	# Stuff
end

Set a callback that is called when data is received from a Characteristic. notify is generally faster than indicate because it does not need to acknowledge that it received the data.

See also indicate

indicate(callback,
	peripheral::Peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC}
)
indicate(
	peripheral::Peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC}
) do data
	# Stuff
end

Set a callback that is called when data is received from a Characteristic. notify is generally faster than indicate because it does not need to acknowledge that it received the data.

See also notify

unsubscribe(
	peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC}
)

unsubscribe from a notify or indicate call.

read_descriptor(
	peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC},
	descriptor::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC}
)

Read data from a descriptor.

write_descriptor(
	peripheral,
	service::Union{AbstractString, SBLEUUID, SBLESERVICE},
	characteristic::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC},
	descriptor::Union{AbstractString, SBLEUUID, SBLECHARACTERISTIC},
	data <: Union{AbstractString, AbstractArray}
)

Write data to a descriptor.

set_callback_on_connected(callback, peripheral)
set_callback_on_connected(peripheral) do
	# Stuff
end

Set a callback that is called when a peripheral is connected.

See also set_callback_on_disconnected

set_callback_on_disconnected(callback, peripheral)
set_callback_on_disconnected(peripheral) do
	# Stuff
end

Set a callback that is called when a peripheral is disconnected.

See also set_callback_on_connected