ble_api.h File Reference

BLE API Documentation for Camera Slider Firmware. More...

Go to the source code of this file.

Macros
#define	BLE_ADV_FAST_TIMEOUT   30
#define	BLE_ADV_INTERVAL_MAX   244
#define	BLE_ADV_INTERVAL_MIN   32
	Advertising configuration.
#define	BLE_BUFFER_SIZE   64
	Buffer management.
#define	BLE_CMD_BACKWARD   'b'
	Move slider backward.
#define	BLE_CMD_FORWARD   'a'
	Move slider forward.
#define	BLE_CMD_POSITION   "pos:"
	Set target position.
#define	BLE_CMD_SPEED   "speed:"
	Set movement speed.
#define	BLE_CMD_STATUS   's'
	Get device status.
#define	BLE_CMD_STOP   'x'
	Emergency stop.
#define	BLE_CONN_AUTO_LED   true
#define	BLE_CONN_BANDWIDTH_MAX   true
	Connection parameters.
#define	BLE_FUTURE_COMMANDS   "Enhanced command set"
	Enhanced command set.
#define	BLE_FUTURE_LOGGING   "Data logging capabilities"
	Data logging.
#define	BLE_FUTURE_MULTI_DEVICE   "Multi-device support"
	Multi-device support.
#define	BLE_MAIN_LOOP   "Main BLE processing loop"
	Main BLE processing loop.
#define	BLE_MOTOR_INTEGRATION   "Direct motor control integration"
	Motor control integration.
#define	BLE_PEER_NAME_MAX   32
#define	BLE_PROCESSING_DELAY   2
#define	BLE_RESP_BUSY   "Error: Device busy"
#define	BLE_RESP_CMD_ACK   "Command received and executed"
	Command acknowledgment responses.
#define	BLE_RESP_ERROR   "Error: Invalid command"
	Error responses.
#define	BLE_RESP_PARAM_ERROR   "Error: Invalid parameter"
#define	BLE_RESP_STATUS_FORMAT   "JSON status object"
	Status response format.
#define	BLE_SERVICE_BATTERY   "Battery Service"
	Battery Service.
#define	BLE_SERVICE_DEVICE_INFO   "Device Information Service"
	Device Information Service.
#define	BLE_SERVICE_DFU   "OTA DFU Service"
	OTA DFU Service.
#define	BLE_SERVICE_UART   "BLE UART Service"
	BLE UART Service.
#define	BLE_TROUBLESHOOT_COMMANDS   "Command troubleshooting guide"
	Command not working.
#define	BLE_TROUBLESHOOT_CONNECTION   "Connection troubleshooting guide"
	Connection issues.
#define	BLE_TROUBLESHOOT_PERFORMANCE   "Performance troubleshooting guide"
	Performance issues.

Detailed Description

BLE API Documentation for Camera Slider Firmware.

Author

Dane Evans

Version

1.0

Date

2024

This file documents the Bluetooth Low Energy (BLE) API interface that allows communication between the camera slider device and a phone/computer. The API is implemented using the Adafruit Bluefruit LE UART service.

Note

This is a documentation-only header file. The actual implementation is in src/bleuart.ino

Definition in file ble_api.h.