ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs

pull/8738/head
paul-szczepanek-arm 2018-11-13 18:01:32 +00:00 committed by Vincent Coubard
parent 6eee528b79
commit 0f4ac44bc5
2 changed files with 111 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
features/FEATURE_BLE/ble/BLETypes.h
View File

@ -407,17 +407,13 @@ enum advertising_type_t {
ADV_CONNECTABLE_DIRECTED_LOW_DUTY
};
/**
* FIXME
/** Used to indicate if the packet is complete and if it's truncated.
*/
struct advertising_data_status_t : SafeEnum<advertising_data_status_t, uint8_t >{
/**
* FIXME
*/
enum type {
COMPLETE = 0x00,
INCOMPLETE_MORE_DATA = 0x01,
INCOMPLETE_DATA_TRUNCATED = 0x02
COMPLETE = 0x00, /**< Advertising payload complete. */
INCOMPLETE_MORE_DATA = 0x01, /**< Partial advertising payload, more to come. */
INCOMPLETE_DATA_TRUNCATED = 0x02 /**< Advertising payload incomplete and no more is comoing. */
};
/**
@ -436,123 +432,94 @@ struct advertising_data_status_t : SafeEnum<advertising_data_status_t, uint8_t
{ }
};
/**
* FIXME
/** Properties of an advertising event.
*/
struct advertising_event_t {
/**
* FIXME
/** Create based on a raw value.
*
* @param value
*/
explicit advertising_event_t(uint8_t value) : value(value) { }
/**
* FIXME
* @return
/** Is advertising connectable.
*
* @return True if connectable.
*/
bool connectable() const
{
return static_cast<bool>(value & (1 << 0));
}
/**
* FIXME
* @return
/** Is advertising scannable.
*
* @return True if scannable
*/
bool scannable_advertising() const
{
return static_cast<bool>(value & (1 << 1));
}
/**
* FIXME
* @return
/** Is advertising directed.
*
* @return True if directed.
*/
bool directed_advertising() const
{
return static_cast<bool>(value & (1 << 2));
}
/**
* FIXME
* @return
/** Is this a scan response.
*
* @return True if scan response.
*/
bool scan_response() const
{
return static_cast<bool>(value & (1 << 3));
}
/**
* FIXME
* @return
/** Is this legacy advertising.
*
* @return True if legacy.
*/
bool legacy_advertising() const
{
return static_cast<bool>(value & (1 << 4));
}
/**
* FIXME
* @return
/** Payload completeness status.
*
* @return @see advertising_data_status_t for details.
*/
advertising_data_status_t data_status() const
{
return static_cast<advertising_data_status_t::type>((value >> 5) & 0x03);
}
/**
* FIXME
* @return
/** Is payload complete.
*
* @return True if payload is coplete.
*/
bool complete() const
{
return data_status() == advertising_data_status_t::COMPLETE;
return data_status().value() == advertising_data_status_t::COMPLETE;
}
/**
* FIXME
* @return
/** Is there more data coming.
*
* @return True if more data coming.
*/
bool more_data_to_come() const
{
return data_status() == advertising_data_status_t::INCOMPLETE_MORE_DATA;
return data_status().value() == advertising_data_status_t::INCOMPLETE_MORE_DATA;
}
/**
* FIXME
* @return
/** Is the payload truncated.
*
* @return True if no more data coming.
*/
bool truncated() const
{
return data_status() == advertising_data_status_t::INCOMPLETE_DATA_TRUNCATED;
}
/**
* FIXME
* @param lhs
* @param rhs
* @return
*/
friend bool operator==(
const advertising_event_t &lhs,
const advertising_event_t &rhs
)
{
return lhs.value == rhs.value;
}
/**
* FIXME
* @param lhs
* @param rhs
* @return
*/
friend bool operator!=(
const advertising_event_t &lhs,
const advertising_event_t &rhs
)
{
return !(rhs == lhs);
return data_status().value() == advertising_data_status_t::INCOMPLETE_DATA_TRUNCATED;
}
private:

148
features/FEATURE_BLE/ble/Gap.h
View File

@ -1203,63 +1203,63 @@ public:
directAddress(directAddress),
advertisingData(advertisingData) { }
const AdvertisingEventType_t &getType() const
{
/** Get event type. */
const AdvertisingEventType_t &getType() const {
return type;
}
const PeerAddressType_t &getPeerAddressType() const
{
/** Get peer address type. */
const PeerAddressType_t &getPeerAddressType() const {
return peerAddressType;
}
const ble::address_t &getPeerAddress() const
{
/** Get peer address. */
const ble::address_t &getPeerAddress() const {
return peerAddress;
}
const Phy_t &getPrimaryPhy() const
{
/** Get primary PHY. */
const Phy_t &getPrimaryPhy() const {
return primaryPhy;
}
const Phy_t &getSecondaryPhy() const
{
/** Get secondary PHY. */
const Phy_t &getSecondaryPhy() const {
return secondaryPhy;
}
ble::advertising_sid_t getSID() const
{
/** Get advertising set identifier. */
ble::advertising_sid_t getSID() const {
return SID;
}
ble::advertising_power_t getTxPower() const
{
/** Get TX power. */
ble::advertising_power_t getTxPower() const {
return txPower;
}
ble::rssi_t getRssi() const
{
/** Get received signal strength. */
ble::rssi_t getRssi() const {
return rssi;
}
UnitPeriodicInterval_t getPeriodicInterval() const
{
/** Get interval. */
UnitPeriodicInterval_t getPeriodicInterval() const {
return periodicInterval;
}
const PeerAddressType_t &getDirectAddressType() const
{
/** Get target address type in directed advertising. */
const PeerAddressType_t &getDirectAddressType() const {
return directAddressType;
}
const ble::address_t &getDirectAddress() const
{
/** Get target address in directed advertising. */
const ble::address_t &getDirectAddress() const {
return directAddress;
}
const mbed::Span<const uint8_t> &getAdvertisingData() const
{
/** Get payload. */
const mbed::Span<const uint8_t> &getAdvertisingData() const {
return advertisingData;
}
@ -1331,58 +1331,58 @@ public:
supervisionTimeout(supervisionTimeout),
masterClockAccuracy(masterClockAccuracy) { }
ble_error_t getStatus() const
{
/** Get connection complete event status. */
ble_error_t getStatus() const {
return status;
}
Handle_t getConnectionHandle() const
{
/** Get connection handle (valid only when successful). */
Handle_t getConnectionHandle() const {
return connectionHandle;
}
Role_t getOwnRole() const
{
/** Get own role. */
Role_t getOwnRole() const {
return ownRole;
}
const PeerAddressType_t &getPeerAddressType() const
{
/** Get peer address type. */
const PeerAddressType_t &getPeerAddressType() const {
return peerAddressType;
}
const ble::address_t &getPeerAddress() const
{
/** Get peer address. */
const ble::address_t &getPeerAddress() const {
return peerAddress;
}
const ble::address_t &getLocalResolvablePrivateAddress() const
{
/** Get get local resolvable random address if privacy is used. */
const ble::address_t &getLocalResolvablePrivateAddress() const {
return localResolvablePrivateAddress;
}
const ble::address_t &getPeerResolvablePrivateAddress() const
{
/** Get peer resolvable private address if privacy is used. */
const ble::address_t &getPeerResolvablePrivateAddress() const {
return peerResolvablePrivateAddress;
}
UnitConnInterval_t getConnectionInterval() const
{
/** Get connection interval. */
UnitConnInterval_t getConnectionInterval() const {
return connectionInterval;
}
UnitSlaveLatency_t getConnectionLatency() const
{
/** Get connection latency. */
UnitSlaveLatency_t getConnectionLatency() const {
return connectionLatency;
}
UnitSupervisionTimeout_t getSupervisionTimeout() const
{
/** Get supervision timeout. */
UnitSupervisionTimeout_t getSupervisionTimeout() const {
return supervisionTimeout;
}
uint16_t getMasterClockAccuracy() const
{
/** Get clock accuracy in parts per million. */
uint16_t getMasterClockAccuracy() const {
return masterClockAccuracy;
}
@ -1415,12 +1415,12 @@ public:
struct PeriodicAdvertisingSyncEstablishedEvent {
/** Create advertising sync event.
*
* @param success BLE_ERROR_NONE if connection succeeded.
* @param success BLE_ERROR_NONE if synchronisation was achieved.
* @param syncHandle Advertising sync handle.
* @param sid Advertising set identifier.
* @param peerAddressType Peer address type.
* @param peerAddress Peer address.
* @param peerPhy Phy used for advertisements.
* @param peerPhy PHY used for advertisements.
* @param advertisingInterval Periodic advertising interval.
* @param masterClockAccuracy Peer clock accuracy in parts per million.
*/
@ -1443,43 +1443,43 @@ public:
advertisingInterval(advertisingInterval),
peerClockAccuracy(peerClockAccuracy) { }
ble_error_t getStatus() const
{
/** Get sync establishment status. */
ble_error_t getStatus() const {
return status;
}
ble::periodic_sync_handle_t getSyncHandle() const
{
/** Get periodic advertising sync handle. */
ble::periodic_sync_handle_t getSyncHandle() const {
return syncHandle;
}
ble::advertising_sid_t getSid() const
{
/** Get advertising set identifier. */
ble::advertising_sid_t getSid() const {
return sid;
}
const PeerAddressType_t &getPeerAddressType() const
{
/** Get peer address type. */
const PeerAddressType_t &getPeerAddressType() const {
return peerAddressType;
}
const ble::address_t &getPeerAddress() const
{
/** Get peer address. */
const ble::address_t &getPeerAddress() const {
return peerAddress;
}
const Phy_t &getPeerPhy() const
{
/** Get PHY used. */
const Phy_t &getPeerPhy() const {
return peerPhy;
}
uint16_t getAdvertisingInterval() const
{
/** Get interval. */
uint16_t getAdvertisingInterval() const {
return advertisingInterval;
}
const ble::clock_accuracy_t &getPeerClockAccuracy() const
{
/** Get clock accuracy in parts per million. */
const ble::clock_accuracy_t &getPeerClockAccuracy() const {
return peerClockAccuracy;
}
@ -1528,28 +1528,28 @@ public:
dataStatus(dataStatus),
payload(payload) { }
ble::periodic_sync_handle_t getSyncHandle() const
{
/** Get periodic advertising sync handle. */
ble::periodic_sync_handle_t getSyncHandle() const {
return syncHandle;
}
ble::advertising_power_t getTxPower() const
{
/** Get TX power as reported by the advertising packet. */
ble::advertising_power_t getTxPower() const {
return txPower;
}
ble::rssi_t getRssi() const
{
/** Get received signal strength. */
ble::rssi_t getRssi() const {
return rssi;
}
const ble::advertising_data_status_t &getDataStatus() const
{
/** Get data completeness status. */
const ble::advertising_data_status_t &getDataStatus() const {
return dataStatus;
}
const mbed::Span<const uint8_t> &getPayload() const
{
/** Get payload. */
const mbed::Span<const uint8_t> &getPayload() const {
return payload;
}