mirror of
https://github.com/bluekitchen/btstack.git
synced 2025-03-29 22:20:37 +00:00
doc: update gatt services and clients
This commit is contained in:
parent
733a7793d2
commit
fcd07a80fc
@ -31,7 +31,7 @@ BTstack is free for non-commercial use. However, for commercial use, <a href="ma
|
||||
|
||||
**GATT Service Servers:** Battery, Cycling Power, Cycling Speed and Cadence, Device Information, Heart Rate, HID over GATT (HOG) Device, Mesh Provisioning, Mesh Proxy, Nordic SPP, Scan Parameters, u-Blox SPP.
|
||||
|
||||
**GATT Service Clients:**: Battery, Device Information, HID-over-GATT (HOG) Host, Scan Parameters.
|
||||
**GATT Service Clients:**: ANCS, Battery, Device Information, HID-over-GATT (HOG) Host, Scan Parameters.
|
||||
|
||||
GATT Services are in general easy to implement and require short development time. For more GATT Services please contact us, or follow the [implementation guidelines](https://bluekitchen-gmbh.com/btstack/profiles/#gatt-generic-attribute-profile).
|
||||
|
||||
|
29
doc/manual/docs/gatt_clients.md
Normal file
29
doc/manual/docs/gatt_clients.md
Normal file
@ -0,0 +1,29 @@
|
||||
|
||||
BTstack allows to implement and use GATT Clients in a modular way.
|
||||
|
||||
### Battery Service Client {#sec:BatteryServiceClient}}
|
||||
|
||||
The Battery Service Client connects to the Battery Services of a remote device and queries its battery level values. Level updates are either received via notifications (if supported by the remote Battery Service), or by manual polling.
|
||||
|
||||
See [Battery Service Client API](appendix/apis/#battery-service-client-api).
|
||||
|
||||
### Device Information Service Client {#sec:DeviceInformationServiceClient}}
|
||||
|
||||
The Device Information Service Client retrieves the following information from a remote device:
|
||||
- manufacturer name
|
||||
- model number
|
||||
- serial number
|
||||
- hardware revision
|
||||
- firmware revision
|
||||
- software revision
|
||||
- system ID
|
||||
- IEEE regulatory certification
|
||||
- PNP ID
|
||||
|
||||
See [Device Information Service Client API](appendix/apis/#device-information-service-client-api).
|
||||
|
||||
### Scan Parameters Service Client {#sec:ScanParametersServiceClient}}
|
||||
|
||||
The Scan Parameters Service Client allows to store its LE scan parameters on a remote device such that the remote device can utilize this information to optimize power consumption and/or reconnection latency.
|
||||
|
||||
See [Scan Parameters Service Client API](appendix/apis/#scan-parameters-service-client-api).
|
@ -1,7 +1,7 @@
|
||||
|
||||
BTstack allows to implement and use GATT Services in a modular way.
|
||||
|
||||
To use an already implemented GATT Service, you only have to add it to your application's
|
||||
To use an already implemented GATT Service Server, you only have to add it to your application's
|
||||
GATT file with:
|
||||
|
||||
- `#import <service_name.gatt>` for .gatt files located in *src/ble/gatt-service*
|
||||
@ -10,7 +10,7 @@ GATT file with:
|
||||
Each service will have an API at *src/ble/gatt-service/service_name_server.h. To activate it, you need
|
||||
to call *service_name_init(..)*. Please see the .h file for details.
|
||||
|
||||
### Battery Service {#sec:BatteryService}}
|
||||
### Battery Service Server {#sec:BatteryServiceServer}}
|
||||
|
||||
The Battery Service allows to query your device's battery level in a standardized way.
|
||||
|
||||
@ -20,8 +20,34 @@ current value of your battery. The valid range for the battery level is 0-100.
|
||||
|
||||
If the battery level changes, you can call *battery_service_server_set_battery_value(value)*. The service supports sending Notifications if the client enables them.
|
||||
|
||||
See [Battery Service Server API](appendix/apis/#battery-service-server-api).
|
||||
|
||||
### Heart Rate Service {#sec:HeartRateService}}
|
||||
### Cycling Power Service Server {#sec:CyclingPowerServiceServer}
|
||||
|
||||
The Cycling Power Service allows to query device's power- and force-related data and optionally speed- and cadence-related data for use in sports and fitness applications.
|
||||
|
||||
To use with your application, add `#import <cycling_power_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Cycling Power Service Server API](appendix/apis/#cycling-power-service-server-api).
|
||||
|
||||
### Cycling Speed and Cadence Service Server {#sec:CyclingSpeedAndCadenceServiceServer}
|
||||
|
||||
The Cycling Speed and Cadence Service allows to query device's speed- and cadence-related data for use in sports and fitness applications.
|
||||
|
||||
To use with your application, add `#import <cycling_speed_and_cadence_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Cycling Speed and Cadence Service Server API](appendix/apis/#cycling-speed-and-cadence-service-server-api).
|
||||
|
||||
### Device Information Service Server {#sec:DeviceInformationServiceServer}
|
||||
|
||||
TheDevice Information Service allows to query manufacturer and/or vendor information about a device.
|
||||
|
||||
To use with your application, add `#import <device_information_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Device Information Service Server API](appendix/apis/#device-information-service-server-api).
|
||||
|
||||
|
||||
### Heart Rate Service Server {#sec:HeartRateServiceServer}}
|
||||
|
||||
The heart rate service server provides heart rate measurements via notifications.
|
||||
|
||||
@ -49,3 +75,45 @@ If energy expanded is supported, you can call *heart_rate_service_add_energy_exp
|
||||
with the newly expanded energy. The accumulated energy expended value
|
||||
will be emitted with the next heart rate measurement.
|
||||
|
||||
See [Heart Rate Service Server API](appendix/apis/#heart-rate-service-server-api).
|
||||
|
||||
|
||||
### Mesh Provisioning Service Server {#sec:MeshProvisioningServiceServer}
|
||||
|
||||
The Mesh Provisioning Service allows a Provisioning Client to provision a device to participate in the mesh network.
|
||||
|
||||
To use with your application, add `#import <mesh_provisioning_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Mesh Provisioning Service Server API](appendix/apis/#mesh-provisioning-service-server-api).
|
||||
|
||||
### Mesh Proxy Service Server {#sec:MeshProxyServiceServer}
|
||||
|
||||
The Mesh Proxy Service is used to enable a server to send and receive Proxy PDUs with a client.
|
||||
|
||||
To use with your application, add `#import <mesh_proxy_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Mesh Proxy Service Server API](appendix/apis/#mesh-proxy-service-server-api).
|
||||
|
||||
### Nordic SPP Service Server {#sec:NordicSPPServiceServer}
|
||||
|
||||
The Nordic SPP Service is implementation of the Nordic SPP-like profile.
|
||||
|
||||
To use with your application, add `#import <nordic_spp_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Nordic SPP Service Server API](appendix/apis/#nordic-spp-service-server-api).
|
||||
|
||||
### Scan Parameters Service Server {#sec:ScanParametersServiceServer}
|
||||
|
||||
The Scan Parameters Service enables a remote GATT Client to store the LE scan parameters it is using locally. These parameters can be utilized by the application to optimize power consumption and/or reconnection latency.
|
||||
|
||||
To use with your application, add `#import <scan_parameters_service.gatt>` to your .gatt file.
|
||||
|
||||
See [Scan Parameters Service Server API](appendix/apis/#scan-parameters-server-api).
|
||||
|
||||
### u-blox SPP Service Server {#sec:ubloxSPPServiceServer}
|
||||
|
||||
The u-blox SPP Service is implementation of the u-Blox SPP-like profile.
|
||||
|
||||
To use with your application, add `#import <ublox_spp_service.gatt>` to your .gatt file.
|
||||
|
||||
See [u-blox SPP Service Server API](appendix/apis/#ublox-spp-service-server-api).
|
Loading…
x
Reference in New Issue
Block a user