/* * Author: Petre Eftime * Copyright (c) 2015 Intel Corporation. * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #pragma once #include "BluetoothObject.hpp" #include "BluetoothManager.hpp" #include "BluetoothGattDescriptor.hpp" #include #include #include /* Forward declaration of types */ struct _Object; typedef struct _Object Object; struct _GattCharacteristic1; typedef struct _GattCharacteristic1 GattCharacteristic1; /** * Provides access to Bluetooth GATT characteristic. Follows the BlueZ adapter API * available at: http://git.kernel.org/cgit/bluetooth/bluez.git/tree/doc/gatt-api.txt */ class tinyb::BluetoothGattCharacteristic: public BluetoothObject { friend class tinyb::BluetoothGattService; friend class tinyb::BluetoothGattDescriptor; friend class tinyb::BluetoothManager; friend class tinyb::BluetoothEventManager; friend class BluetoothNotificationHandler; private: GattCharacteristic1 *object; protected: BluetoothGattCharacteristic(GattCharacteristic1 *object); static std::unique_ptr make(Object *object, BluetoothType type = BluetoothType::GATT_CHARACTERISTIC, std::string *name = nullptr, std::string *identifier = nullptr, BluetoothObject *parent = nullptr); std::function &)> value_changed_callback; bool start_notify (); bool stop_notify (); public: static std::string java_class() { return std::string(JAVA_DBUS_PACKAGE "/DBusGattCharacteristic"); } static BluetoothType class_type() { return BluetoothType::GATT_CHARACTERISTIC; } virtual std::string get_java_class() const; virtual std::string get_class_name() const ; virtual std::string get_object_path() const; virtual BluetoothType get_bluetooth_type() const; BluetoothGattCharacteristic(const BluetoothGattCharacteristic &object); ~BluetoothGattCharacteristic(); virtual BluetoothGattCharacteristic *clone() const; std::unique_ptr find( std::string *identifier, std::chrono::milliseconds timeout = std::chrono::milliseconds::zero()) { BluetoothManager *manager = BluetoothManager::get_bluetooth_manager(); return manager->find(nullptr, identifier, this, timeout); } /* D-Bus method calls: */ /** Reads the value of this characteristic. * @return A std::vector containing the value of this characteristic. */ std::vector read_value ( uint16_t offset = 0 ); /** Writes the value of this characteristic. * @param[in] arg_value The data as vector * to be written packed in a GBytes struct * @return TRUE if value was written succesfully */ bool write_value (const std::vector &arg_value, uint16_t offset = 0); /** * Enables notifications (including at BLE level) for changes of the * value of the characteristic and triggers the callback when the * value changes. * Uninstalls the previous value callback, if any was installed. * @param callback A function of the form * void(BluetoothGattCharacteristic&, std::vector &, void *), where * BluetoothGattCharacteristic& is the adapter for which the callback was * set, bool will contain the new value of the powered property and void * * contains optional, user set data * @param userdata The data which will be delivered to the callback when it is triggered. * Memory must be managed by user. */ bool enable_value_notifications( std::function &value,void *userdata)> callback, void *user_data); /** * Enables notifications (including at BLE level) for changes of the * value of the characteristic and triggers the callback when the * value changes. * Uninstalls the previous powered callback, if any was installed. * @param callback A function of the form void(std::vector &), where * std::vector& will contain the new value */ bool enable_value_notifications( std::function &value)> callback); /** * Disables notifications for changes of the value of the characteristic * and uninstalls any callback (including BLE level). */ bool disable_value_notifications(); /* D-Bus property accessors: */ /** Get the UUID of this characteristic. * @return The 128 byte UUID of this characteristic, NULL if an error occurred */ std::string get_uuid (); /** Returns the service to which this characteristic belongs to. * @return The service. */ BluetoothGattService get_service (); /** Returns the cached value of this characteristic, if any. * @return The cached value of this characteristic. */ std::vector get_value (); /** Returns true if notification for changes of this characteristic are * activated. * @return True if notificatios are activated. */ bool get_notifying (); /** Returns the flags this characterstic has. * @return A list of flags for this characteristic. */ std::vector get_flags (); /** Returns a list of BluetoothGattDescriptors this characteristic exposes. * @return A list of BluetoothGattDescriptors exposed by this characteristic * NULL if an error occurred */ std::vector> get_descriptors (); };