Add generic byte RingBuffer class

api/ArduinoAPI.h

@@ -0,0 +1,26 @@
+/*
+  Arduino API main include
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_API_H
+#define ARDUINO_API_H
+
+// version 1.0.0
+#define ARDUINO_API_VERSION 10000
+
+#endif

api/BLE/central/ArduinoBLECentral.h

@@ -0,0 +1,27 @@
+/*
+  BLE Central API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_BLE_CENTRAL_H
+#define ARDUINO_BLE_CENTRAL_H
+
+#define ARDUINO_BLE_API_VERSION 10000 // version 1.0.0
+
+#include <BLECentral.h>
+
+#endif

api/BLE/central/BLECentral.h

@@ -0,0 +1,53 @@
+/*
+  BLE Central API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_BLE_CENTRAL_H
+#define ARDUINO_BLE_CENTRAL_H
+
+#include <Arduino.h>
+
+#include "BLERemotePeripheral.h"
+#include "BLERemotePeripheralCharacteristic.h"
+
+enum BLECentralEvent {
+  BLEDiscovered = 0
+};
+
+typedef void (*BLECentralEventHandler)(BLERemotePeripheral& peripheral);
+
+class BLECentral
+{
+  public:
+    BLECentral();
+    virtual ~BLECentral();
+
+    void begin(); // initiliaze hardware
+    void poll(); // poll for events
+    void end(); // deinitiliaze hardware
+
+    void startScanning(); // start scanning for peripherals
+    void startScanningWithDuplicates(); // start scanning for peripherals, and report all duplicates
+    void stopScanning(); // stop scanning for peripherals
+
+    BLERemotePeripheral available(); // retrieve a discovered peripheral
+
+    void setEventHandler(BLECentralEvent event, BLECentralEventHandler eventHandler); // set an event handler (callback)
+};
+
+#endif

api/BLE/central/BLERemotePeripheral.h

@@ -0,0 +1,83 @@
+/*
+  BLE Remote Peripheral API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+
+#ifndef ARDUINO_BLE_REMOTE_PERIPHERAL_H
+#define ARDUINO_BLE_REMOTE_PERIPHERAL_H
+
+#include <Arduino.h>
+
+#include "BLERemotePeripheralService.h"
+#include "BLERemotePeripheralCharacteristic.h"
+#include "BLERemotePeripheralDescriptor.h"
+
+enum BLERemotePeripheralEvent {
+  BLERemoteDisconnected = 0
+};
+
+class BLERemotePeripheral;
+
+typedef void (*BLERemotePeripheralEventHandler)(BLERemotePeripheral& peripheral);
+
+class BLERemotePeripheral
+{
+  public:
+    BLERemotePeripheral();
+    virtual ~BLERemotePeripheral();
+
+    operator bool() const; // is the peripheral valid (discovered)
+
+    String address() const; // returns the BT address of the peripheral as a String
+    int rssi() const; // returns the RSSI of the peripheral at discovery
+
+    bool hasLocalName() const; // does the peripheral advertise a local name
+    bool hasAdvertisedService() const; // does the peripheral advertise a service
+    bool hasAdvertisedService(int index) const; // does the peripheral advertise a service n
+
+    String localName() const; // returns the advertised local name as a String
+    String advertisedService() const; // returns the advertised service as a UUID String
+    String advertisedService(int index) const; // returns the nth advertised service as a UUID String
+
+    bool connect(); // connect to the peripheral
+    bool disconnect(); // disconnect from the peripheral
+    bool connected(); // is the peripheral connected
+
+    bool discoverAttributes(); // discover the peripherals attributes (services, characteristic, and descriptors)
+
+    String deviceName(); // read the device name attribute of the peripheral, and return String value
+    unsigned short appearance(); // read the appearance attribute of the peripheral and return value as int
+
+    void setEventHandler(BLERemotePeripheralEvent event, BLERemotePeripheralEventHandler eventHandler); // set an event handler (callback)
+
+    int serviceCount() const; // returns the number of services the peripheral has
+    bool hasService(const char* uuid) const; // does the peripheral have a service with the specified UUID
+    bool hasService(const char* uuid, int index) const;  // does the peripheral have an nth service with the specified UUID
+    BLERemotePeripheralService service(int index) const; // return the nth service of the peripheral
+    BLERemotePeripheralService service(const char * uuid) const; // return the service with the specified UUID
+    BLERemotePeripheralService service(const char * uuid, int index) const; // return the nth service with the specified UUID
+
+    int characteristicCount() const; // returns the number of characteristics the peripheral has
+    bool hasCharacteristic(const char* uuid) const; // does the peripheral have a characteristic with the specified UUID
+    bool hasCharacteristic(const char* uuid, int index) const; // does the peripheral have an nth characteristic with the specified UUID
+    BLERemotePeripheralCharacteristic characteristic(int index) const; // return the nth characteristic of the peripheral
+    BLERemotePeripheralCharacteristic characteristic(const char * uuid) const; // return the characteristic with the specified UUID
+    BLERemotePeripheralCharacteristic characteristic(const char * uuid, int index) const; // return the nth characteristic with the specified UUID
+};
+
+#endif

api/BLE/central/BLERemotePeripheralAttribute.h

@@ -0,0 +1,31 @@
+/*
+  BLE Remote Peripheral Attribute API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_BLE_REMOTE_PERIPHERAL_ATTRIBUTE_H
+#define ARDUINO_BLE_REMOTE_PERIPHERAL_ATTRIBUTE_H
+
+class BLERemotePeripheralAttribute
+{
+  public:
+    BLERemotePeripheralAttribute();
+
+    String uuid() const; // returns the UUID of the attribute as a String
+};
+
+#endif

api/BLE/central/BLERemotePeripheralAttributeWithValue.h

@@ -0,0 +1,66 @@
+/*
+  BLE Remote Peripheral Attribute with value API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_BLE_REMOTE_PERIPHERAL_ATTRIBUTE_H
+#define ARDUINO_BLE_REMOTE_PERIPHERAL_ATTRIBUTE_H
+
+#include "BLERemotePeripheralAttribute.h"
+
+
+class BLERemotePeripheralAttributeWithValue : public BLERemotePeripheralAttribute
+{
+  public:
+    BLERemotePeripheralAttributeWithValue();
+
+    virtual bool read(); // read the attribute value from the peripheral
+    virtual bool write(const unsigned char* value, int length); // write the specific value to the attribute of the peripheral
+
+    int valueLength() const; // returns the length of the attribute value
+    const unsigned char* value() const; // returns the value of the attribute array
+    unsigned char operator[] (int offset) const; // access an attribute value at the specified offset
+
+    // intepret the value of the attribute with the specified type
+    String stringValue() const;
+    char charValue() const;
+    unsigned char unsignedCharValue() const;
+    short shortValue() const;
+    unsigned short unsignedShortValue() const;
+    int intValue() const;
+    unsigned int unsignedIntValue() const;
+    long longValue() const;
+    unsigned long unsignedLongValue() const;
+    float floatValue() const;
+    double doubleValue() const;
+
+    // write the value of the attribute with the specified type
+    bool writeString(const String& s);
+    bool writeString(const char* s);
+    bool writeChar(char c);
+    bool writeUnsignedChar(unsigned char c);
+    bool writeShort(short s);
+    bool writeUnsignedShort(unsigned short s);
+    bool writeInt(int i);
+    bool writeUnsignedInt(unsigned int i);
+    bool writeLong(long l);
+    bool writeUnsignedLong(unsigned int l);
+    bool writeFloat(float f);
+    bool writeDouble(double d);
+};
+
+#endif

api/BLE/central/BLERemotePeripheralCharacteristic.h

@@ -0,0 +1,66 @@
+/*
+  BLE Remote Peripheral Characteristic API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_BLE_REMOTE_PERIPHERAL_CHARACTERISTIC_H
+#define ARDUINO_BLE_REMOTE_PERIPHERAL_CHARACTERISTIC_H
+
+#include "BLERemotePeripheralAttributeWithValue.h"
+#include "BLERemotePeripheralDescriptor.h"
+
+enum BLERemotePeripheralCharacteristicEvent {
+  BLERemoteValueUpdated = 0
+};
+
+class BLERemotePeripheralCharacteristic;
+
+typedef void (*BLERemotePeripheralCharacteristicEventHandler)(BLERemotePeripheral& peripheral, BLERemotePeripheralCharacteristic& characteristic);
+
+class BLERemotePeripheralCharacteristic : public BLERemotePeripheralAttributeWithValue
+{
+  public:
+    BLERemotePeripheralCharacteristic();
+
+    operator bool() const; // is the characteristic valid (discovered from peripheral)
+
+    unsigned char properties() const; // returns the properties of the characteristic
+
+    bool canRead(); // can the characteristic be read (based on properties)
+    bool canWrite(); // can the characteristic be written (based on properties)
+    bool canSubscribe(); // can the characteristic be subscribed to (based on properties)
+    bool canUnsubscribe(); // can the characteristic be unsubscribed to (based on properties)
+
+    virtual bool read(); // read the characteristic value
+    virtual bool write(const unsigned char* value, int length); // write the charcteristic value
+
+    bool subscribe(); // subscribe to the characteristic
+    bool unsubscribe(); // unsubscribe to the characteristic
+
+    bool valueUpdated(); // has the characteristic value been updated
+
+    void setEventHandler(BLERemotePeripheralCharacteristicEvent event, BLERemotePeripheralCharacteristicEventHandler eventHandler); // set an event handler (callback)
+
+    int descriptorCount() const; // returns the number of descriptors the characteristic has
+    bool hasDescriptor(const char* uuid) const; // does the characteristic have a descriptor with the specified UUID
+    bool hasDescriptor(const char* uuid, int index) const; // does the characteristic have an nth descriptor with the specified UUID
+    BLERemotePeripheralDescriptor descriptor(int index) const; // return the nth descriptor of the characteristic
+    BLERemotePeripheralDescriptor descriptor(const char * uuid) const; // return the descriptor with the specified UUID
+    BLERemotePeripheralDescriptor descriptor(const char * uuid, int index) const; // return the nth descriptor with the specified UUID
+};
+
+#endif

api/BLE/central/BLERemotePeripheralDescriptor.h

@@ -0,0 +1,38 @@
+/*
+  BLE Remote Peripheral Descriptor API
+  Copyright (c) 2016 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_BLE_REMOTE_PERIPHERAL_DESCRIPTOR_H
+#define ARDUINO_BLE_REMOTE_PERIPHERAL_DESCRIPTOR_H
+
+#include "BLERemotePeripheralAttributeWithValue.h"
+
+class BLERemotePeripheral;
+
+class BLERemotePeripheralDescriptor : public BLERemotePeripheralAttributeWithValue
+{
+  public:
+    BLERemotePeripheralDescriptor();
+
+    operator bool() const;  // is the descriptor valid (discovered from peripheral)
+
+    virtual bool read();  // read the descriptor value
+    virtual bool write(const unsigned char* value, int length);  // write the descriptor value
+};
+
+#endif