#include <yocto_bluetoothlink.h>
Public Member Functions | |
virtual int | _invokeValueCallback (string value) |
string | command (void) |
virtual int | connect (void) |
virtual int | disconnect (void) |
string | get_command (void) |
int | get_linkQuality (void) |
Y_LINKSTATE_enum | get_linkState (void) |
Y_MUTE_enum | get_mute (void) |
string | get_ownAddress (void) |
string | get_pairingPin (void) |
int | get_preAmplifier (void) |
string | get_remoteAddress (void) |
string | get_remoteName (void) |
int | get_volume (void) |
int | linkQuality (void) |
Y_LINKSTATE_enum | linkState (void) |
Y_MUTE_enum | mute (void) |
YBluetoothLink * | next (void) |
YBluetoothLink * | nextBluetoothLink (void) |
string | ownAddress (void) |
string | pairingPin (void) |
int | preAmplifier (void) |
virtual int | registerValueCallback (YBluetoothLinkValueCallback callback) |
string | remoteAddress (void) |
string | remoteName (void) |
int | set_command (const string &newval) |
int | set_mute (Y_MUTE_enum newval) |
int | set_pairingPin (const string &newval) |
int | set_preAmplifier (int newval) |
int | set_remoteAddress (const string &newval) |
int | set_volume (int newval) |
int | setCommand (const string &newval) |
int | setMute (Y_MUTE_enum newval) |
int | setPairingPin (const string &newval) |
int | setPreAmplifier (int newval) |
int | setRemoteAddress (const string &newval) |
int | setVolume (int newval) |
int | volume (void) |
~YBluetoothLink () | |
Public Member Functions inherited from YFunction | |
void | _clearDataStreamCache () |
string | _decode_json_string (const string &json) |
string | _download (const string &url) |
YDataStream * | _findDataStream (YDataSet &dataset, const string &def) |
string | _get_json_path (const string &json, const string &path) |
vector< string > | _json_get_array (const string &json) |
string | _json_get_key (const string &json, const string &data) |
string | _json_get_string (const string &json) |
int | _parseEx (yJsonStateMachine &j) |
virtual int | _parserHelper (void) |
string | _parseString (yJsonStateMachine &j) |
string | _request (const string &request) |
string | _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context) |
void | _throw (YRETCODE errType, string errMsg) |
YRETCODE | _upload (const string &path, const string &content) |
YRETCODE | _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context) |
string | advertisedValue (void) |
void | clearCache () |
string | describe (void) |
string | errMessage (void) |
string | errorMessage (void) |
YRETCODE | errorType (void) |
YRETCODE | errType (void) |
YFUN_DESCR | functionDescriptor (void) |
string | get_advertisedValue (void) |
string | get_errorMessage (void) |
YRETCODE | get_errorType (void) |
virtual string | get_friendlyName (void) |
YFUN_DESCR | get_functionDescriptor (void) |
string | get_functionId (void) |
string | get_hardwareId (void) |
string | get_hubSerial () |
string | get_logicalName (void) |
YModule * | get_module (void) |
void * | get_userData (void) |
bool | isOnline (void) |
YRETCODE | load (int msValidity) |
virtual string | loadAttribute (string attrName) |
string | logicalName (void) |
YModule * | module (void) |
virtual int | muteValueCallbacks (void) |
YFunction * | next (void) |
YFunction * | nextFunction (void) |
virtual int | registerValueCallback (YFunctionValueCallback callback) |
int | set_advertisedValue (const string &newval) |
int | set_logicalName (const string &newval) |
void | set_userData (void *data) |
int | setAdvertisedValue (const string &newval) |
int | setLogicalName (const string &newval) |
void | setUserData (void *data) |
virtual int | unmuteValueCallbacks (void) |
void * | userData (void) |
virtual | ~YFunction () |
Static Public Member Functions | |
static YBluetoothLink * | Find (string func) |
static YBluetoothLink * | FindBluetoothLink (string func) |
static YBluetoothLink * | First (void) |
static YBluetoothLink * | FirstBluetoothLink (void) |
Static Public Member Functions inherited from YFunction | |
static void | _ClearCache (void) |
static YFunction * | Find (string func) |
static YFunction * | FindFunction (string func) |
static YFunction * | First (void) |
static YFunction * | FirstFunction (void) |
Protected Member Functions | |
virtual int | _parseAttr (YJSONObject *json_val) |
YBluetoothLink (const string &func) | |
Protected Member Functions inherited from YFunction | |
YRETCODE | _buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg) |
string | _escapeAttr (const string &changeval) |
YRETCODE | _getDescriptor (YFUN_DESCR &fundescr, string &errMsg) |
YRETCODE | _getDevice (YDevice *&dev, string &errMsg) |
YRETCODE | _load_unsafe (int msValidity) |
YRETCODE | _nextFunction (string &hwId) |
int | _parse (YJSONObject *j) |
YRETCODE | _setAttr (string attrname, string newvalue) |
YFunction (const string &func) | |
Protected Attributes | |
string | _command |
int | _linkQuality |
Y_LINKSTATE_enum | _linkState |
Y_MUTE_enum | _mute |
string | _ownAddress |
string | _pairingPin |
int | _preAmplifier |
string | _remoteAddress |
string | _remoteName |
YBluetoothLinkValueCallback | _valueCallbackBluetoothLink |
int | _volume |
Protected Attributes inherited from YFunction | |
string | _advertisedValue |
u64 | _cacheExpiration |
string | _className |
std::map< string, YDataStream * > | _dataStreams |
string | _func |
YFUN_DESCR | _fundescr |
string | _funId |
string | _hwId |
string | _lastErrorMsg |
YRETCODE | _lastErrorType |
string | _logicalName |
string | _serial |
yCRITICAL_SECTION | _this_cs |
void * | _userData |
YFunctionValueCallback | _valueCallbackFunction |
Friends | |
YBluetoothLink * | yFindBluetoothLink (const string &func) |
YBluetoothLink * | yFirstBluetoothLink (void) |
Additional Inherited Members | |
Static Protected Member Functions inherited from YFunction | |
static void | _AddToCache (const string &classname, const string &func, YFunction *obj) |
static YFunction * | _FindFromCache (const string &classname, const string &func) |
static void | _UpdateTimedReportCallbackList (YFunction *func, bool add) |
static void | _UpdateValueCallbackList (YFunction *func, bool add) |
Static Protected Attributes inherited from YFunction | |
static std::map< string, YFunction * > | _cache |
YBluetoothLink Class: BluetoothLink function interface
BluetoothLink function provides control over bluetooth link and status for devices that are bluetooth-enabled.
Definition at line 92 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 51 of file yocto_bluetoothlink.cpp.
YBluetoothLink::~YBluetoothLink | ( | ) |
Definition at line 69 of file yocto_bluetoothlink.cpp.
|
virtual |
Reimplemented from YFunction.
Definition at line 630 of file yocto_bluetoothlink.cpp.
|
protectedvirtual |
Reimplemented from YFunction.
Definition at line 82 of file yocto_bluetoothlink.cpp.
|
inline |
Definition at line 330 of file yocto_bluetoothlink.h.
|
virtual |
Attempt to connect to the previously selected remote device.
On failure, throws an exception or returns a negative error code.
Definition at line 647 of file yocto_bluetoothlink.cpp.
|
virtual |
Disconnect from the previously selected remote device.
On failure, throws an exception or returns a negative error code.
Definition at line 659 of file yocto_bluetoothlink.cpp.
|
inlinestatic |
Definition at line 401 of file yocto_bluetoothlink.h.
|
static |
Retrieves a cellular interface for a given identifier. The identifier can be specified using several formats:
This function does not require that the cellular interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YBluetoothLink.isOnline() to test if the cellular interface is indeed online at a given time. In case of ambiguity when looking for a cellular interface by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
func | : a string that uniquely characterizes the cellular interface |
Definition at line 579 of file yocto_bluetoothlink.cpp.
|
inlinestatic |
Definition at line 425 of file yocto_bluetoothlink.h.
|
static |
Starts the enumeration of cellular interfaces currently accessible. Use the method YBluetoothLink.nextBluetoothLink() to iterate on next cellular interfaces.
Definition at line 674 of file yocto_bluetoothlink.cpp.
string YBluetoothLink::get_command | ( | void | ) |
Definition at line 514 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::get_linkQuality | ( | void | ) |
Returns the bluetooth receiver signal strength, in pourcents, or 0 if no connection is established.
On failure, throws an exception or returns Y_LINKQUALITY_INVALID.
Definition at line 492 of file yocto_bluetoothlink.cpp.
Y_LINKSTATE_enum YBluetoothLink::get_linkState | ( | void | ) |
Returns the bluetooth link state.
On failure, throws an exception or returns Y_LINKSTATE_INVALID.
Definition at line 462 of file yocto_bluetoothlink.cpp.
Y_MUTE_enum YBluetoothLink::get_mute | ( | void | ) |
Returns the state of the mute function.
On failure, throws an exception or returns Y_MUTE_INVALID.
Definition at line 298 of file yocto_bluetoothlink.cpp.
string YBluetoothLink::get_ownAddress | ( | void | ) |
Returns the MAC-48 address of the bluetooth interface, which is unique on the bluetooth network.
On failure, throws an exception or returns Y_OWNADDRESS_INVALID.
Definition at line 126 of file yocto_bluetoothlink.cpp.
string YBluetoothLink::get_pairingPin | ( | void | ) |
Returns an opaque string if a PIN code has been configured in the device to access the SIM card, or an empty string if none has been configured or if the code provided was rejected by the SIM card.
On failure, throws an exception or returns Y_PAIRINGPIN_INVALID.
Definition at line 159 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::get_preAmplifier | ( | void | ) |
Returns the audio pre-amplifier volume, in per cents.
On failure, throws an exception or returns Y_PREAMPLIFIER_INVALID.
Definition at line 353 of file yocto_bluetoothlink.cpp.
string YBluetoothLink::get_remoteAddress | ( | void | ) |
Returns the MAC-48 address of the remote device to connect to.
On failure, throws an exception or returns Y_REMOTEADDRESS_INVALID.
Definition at line 215 of file yocto_bluetoothlink.cpp.
string YBluetoothLink::get_remoteName | ( | void | ) |
Returns the bluetooth name the remote device, if found on the bluetooth network.
On failure, throws an exception or returns Y_REMOTENAME_INVALID.
Definition at line 269 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::get_volume | ( | void | ) |
Returns the connected headset volume, in per cents.
On failure, throws an exception or returns Y_VOLUME_INVALID.
Definition at line 407 of file yocto_bluetoothlink.cpp.
|
inline |
Definition at line 325 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 312 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 235 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 412 of file yocto_bluetoothlink.h.
YBluetoothLink * YBluetoothLink::nextBluetoothLink | ( | void | ) |
Continues the enumeration of cellular interfaces started using yFirstBluetoothLink().
Definition at line 664 of file yocto_bluetoothlink.cpp.
|
inline |
Definition at line 155 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 171 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 261 of file yocto_bluetoothlink.h.
|
virtual |
Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.
callback | : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value. |
Definition at line 611 of file yocto_bluetoothlink.cpp.
|
inline |
Definition at line 198 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 223 of file yocto_bluetoothlink.h.
int YBluetoothLink::set_command | ( | const string & | newval | ) |
Definition at line 536 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::set_mute | ( | Y_MUTE_enum | newval | ) |
Changes the state of the mute function. Remember to call the matching module saveToFlash() method to save the setting permanently.
newval | : either Y_MUTE_FALSE or Y_MUTE_TRUE, according to the state of the mute function |
On failure, throws an exception or returns a negative error code.
Definition at line 330 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::set_pairingPin | ( | const string & | newval | ) |
Changes the PIN code used by the module for bluetooth pairing. Remember to call the saveToFlash() method of the module to save the new value in the device flash.
newval | : a string corresponding to the PIN code used by the module for bluetooth pairing |
On failure, throws an exception or returns a negative error code.
Definition at line 192 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::set_preAmplifier | ( | int | newval | ) |
Changes the audio pre-amplifier volume, in per cents.
newval | : an integer corresponding to the audio pre-amplifier volume, in per cents |
On failure, throws an exception or returns a negative error code.
Definition at line 384 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::set_remoteAddress | ( | const string & | newval | ) |
Changes the MAC-48 address defining which remote device to connect to.
newval | : a string corresponding to the MAC-48 address defining which remote device to connect to |
On failure, throws an exception or returns a negative error code.
Definition at line 246 of file yocto_bluetoothlink.cpp.
int YBluetoothLink::set_volume | ( | int | newval | ) |
Changes the connected headset volume, in per cents.
newval | : an integer corresponding to the connected headset volume, in per cents |
On failure, throws an exception or returns a negative error code.
Definition at line 438 of file yocto_bluetoothlink.cpp.
|
inline |
Definition at line 334 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 249 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 186 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 274 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 211 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 299 of file yocto_bluetoothlink.h.
|
inline |
Definition at line 286 of file yocto_bluetoothlink.h.
|
friend |
Retrieves a cellular interface for a given identifier. The identifier can be specified using several formats:
This function does not require that the cellular interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YBluetoothLink.isOnline() to test if the cellular interface is indeed online at a given time. In case of ambiguity when looking for a cellular interface by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
func | : a string that uniquely characterizes the cellular interface |
Definition at line 462 of file yocto_bluetoothlink.h.
|
friend |
Starts the enumeration of cellular interfaces currently accessible. Use the method YBluetoothLink.nextBluetoothLink() to iterate on next cellular interfaces.
Definition at line 473 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 109 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 108 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 107 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 104 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 100 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 101 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 105 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 102 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 103 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 110 of file yocto_bluetoothlink.h.
|
protected |
Definition at line 106 of file yocto_bluetoothlink.h.
|
static |
Definition at line 143 of file yocto_bluetoothlink.h.
|
static |
Definition at line 142 of file yocto_bluetoothlink.h.
|
static |
Definition at line 135 of file yocto_bluetoothlink.h.
|
static |
Definition at line 138 of file yocto_bluetoothlink.h.
|
static |
Definition at line 136 of file yocto_bluetoothlink.h.
|
static |
Definition at line 141 of file yocto_bluetoothlink.h.
|
static |
Definition at line 139 of file yocto_bluetoothlink.h.
|
static |
Definition at line 140 of file yocto_bluetoothlink.h.
|
static |
Definition at line 137 of file yocto_bluetoothlink.h.
|
static |
Definition at line 130 of file yocto_bluetoothlink.h.
|
static |
Definition at line 132 of file yocto_bluetoothlink.h.
|
static |
Definition at line 131 of file yocto_bluetoothlink.h.
|
static |
Definition at line 126 of file yocto_bluetoothlink.h.
|
static |
Definition at line 127 of file yocto_bluetoothlink.h.
|
static |
Definition at line 133 of file yocto_bluetoothlink.h.
|
static |
Definition at line 128 of file yocto_bluetoothlink.h.
|
static |
Definition at line 129 of file yocto_bluetoothlink.h.
|
static |
Definition at line 134 of file yocto_bluetoothlink.h.