Skip to content

/ ArduinoCore-API

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rough idea for backwards compatibility with old BLE API #12

Closed
wants to merge 49 commits into from
Closed

Rough idea for backwards compatibility with old BLE API #12

wants to merge 49 commits into from

Conversation

@sandeepmistry
Copy link
Contributor

@sandeepmistry sandeepmistry commented Sep 28, 2016

I'm not planning to merge this, it's more to get the discussion going.

cc/ @SidLeung @sgbihu
cmaglie added 14 commits Mar 18, 2016
@cmaglie
Real Time Clock API - first draft
0ac12b9
@cmaglie
Added motion interfaces
dfe0136
@cmaglie
Fixed some typos
0e1a28b
@cmaglie
Added Rotation and Quaternion structures
67b8914
@cmaglie
Renamed Motion.h -> MotionSense.h. Added some comments
9924ebc
@cmaglie
added Magnetometer class
3eef53d
@cmaglie
Added some comments about units. Renamed Gyro -> Gyroscope
b66a1bb
@cmaglie
Correct quaternion order
4c1e94f
@cmaglie
EulerAngles is a more appropriate name
0a9804f
@cmaglie
Added Magnetometer.expectedMagneticFieldStrength() method
6e0ca14
@cmaglie
Added comment on EulerAngles units
0a96c9a
@cmaglie
No defaults FIFO methods for gyroscope.
9be6359 
The data provided from gyroscope has no sense without timing
information. This means that a correct FIFO or rate-limiting must
be implemented from the sub-class.

Close #1
@cmaglie
Added TimeProvider and related functions
bde41a3
@cmaglie
Added basic SoftwareRTC implementation.
58dae9e 
See #3
@damellis

This comment has been minimized.

Sign in to view
Copy link

@damellis damellis commented on api/RealTimeClock.h in bde41a3 Apr 8, 2016

This is a very minor point, but what about calling this setTimeProvider()?
sandeepmistry and others added 15 commits Apr 14, 2016
@sandeepmistry
Add initial BLE API based on the BLEPeripheral library
c400495
@sandeepmistry
Move BLE peripheral API into own folder
38424e2
@sandeepmistry
Correct typo
49795df
@sandeepmistry
First draft of BLE central API
43c0daa
@cmaglie
Added a generic ArduinoAPI.h include folder with API version definitions
4827027
@cmaglie
Removed ARDUINO_REAL_TIME_CLOCK_API_VERSION
4f8b4b2 
it's now implicit from general API version
@cmaglie
Fixed return value on SoftwareRTC::setTime
e255e3d
@sandeepmistry
Add new draft of combine peripheral + central API
76152c7
@sandeepmistry
Add missing methods
b8148e1
@sandeepmistry
Add central examples
21dba27
@sandeepmistry
Add peripheral examples
464951e
@sandeepmistry
Remove old BLE stuff
556e1e5
@sandeepmistry
Add checks for desired characteristic
8f174d4
@sandeepmistry
Add BLE. setAdvertisedService(service) function
9f78506
@sandeepmistry
Add I2S API to get the discussion started
9fb9a33
sandeepmistry added 18 commits Sep 16, 2016
@sandeepmistry
Initial AudioStream
610f816
@sandeepmistry
Rename sampleSize to bitsPerSample
1a533d0
@sandeepmistry
Add channels API
5b1dadf
@sandeepmistry
I2S now extends AudioStream
15b53dd
@sandeepmistry
Add AudioBuffer based on AudioStream
8252004
@sandeepmistry
Add WaveFile backed by SD File
6874060
@sandeepmistry
Add I2S to Wave and Wave to I2S examples
6e352b3
@sandeepmistry
Move I2S to Audio folder
91ee581
@sandeepmistry
Update I2S receiver and sender example
2cd4d1f
@sandeepmistry
Add license headers
d9375af
@sandeepmistry
Audio data is signed
6dc12f4
@sandeepmistry
Correct brackets
ae8eb6d
@sandeepmistry
Split out I2S API
f35db8c
@sandeepmistry
Rename ArduinoI2S.h to I2S.h
8ae764d
@sandeepmistry
Audio -> Sound
f534341
@sandeepmistry
Remove Audio for now
22d97fc
@sandeepmistry
AudioOut now plays AudioIn
f64747c
@sandeepmistry
Rough idea for backwards compatibility with old API
e4d79a3
@sandeepmistry sandeepmistry mentioned this pull request Sep 28, 2016
Closed
@sgbihu
sgbihu reviewed Sep 29, 2016
View changes
api/BLE/BLECharacteristic.h Outdated
@@ -39,7 +39,8 @@ enum BLEProperty {
BLEIndicate = 0x20
};

typedef void (*BLECharacteristicEventHandler)(BLECentral& central, BLECharacteristic& characteristic);
typedef void (*BLECharacteristicEventHandler)(BLECentral central, BLECharacteristic characteristic);

This comment has been minimized.

Sign in to view
@sgbihu

sgbihu Sep 29, 2016

Their has a conflict between BLECentral and BLEDevice. At least, their should define another function type with BLEDevice parameter. Or the new API can't schedule the event.

This comment has been minimized.

Sign in to view
@sandeepmistry

sandeepmistry Sep 29, 2016
Author Contributor

I'll push a change for this:

typedef void (*BLECharacteristicEventHandler)(BLEDevice central, BLECharacteristic characteristic);
typedef void (*BLECharacteristicEventHandlerOld)(BLECentral &central, BLECharacteristic &characteristic); // deprecated
api/BLE/BLEDevice.h
@@ -30,7 +30,7 @@ enum BLEDeviceEvent {
BLEDisconnected = 2,
};

typedef void (*BLEDeviceEventHandler)(BLEDevice& device);
typedef void (*BLEDeviceEventHandler)(BLEDevice device);

This comment has been minimized.

Sign in to view
@sgbihu

sgbihu Sep 29, 2016

Can you tell me the reason about not use reference? The copy my have some overload.

This comment has been minimized.

Sign in to view
@sandeepmistry

sandeepmistry Sep 29, 2016
Author Contributor

This was a request from @tigoe (#7 (comment)).

From what I recall, the bigger discussion was related to beginners being confused by the syntax. @tigoe let me know if I missed something or didn't explain it correctly.
@sandeepmistry
sandeepmistry reviewed Sep 29, 2016
View changes
api/BLE/BLECharacteristic.h Outdated
@@ -39,7 +39,8 @@ enum BLEProperty {
BLEIndicate = 0x20
};

typedef void (*BLECharacteristicEventHandler)(BLECentral& central, BLECharacteristic& characteristic);
typedef void (*BLECharacteristicEventHandler)(BLECentral central, BLECharacteristic characteristic);

This comment has been minimized.

Sign in to view
@sandeepmistry

sandeepmistry Sep 29, 2016
Author Contributor

I'll push a change for this:

typedef void (*BLECharacteristicEventHandler)(BLEDevice central, BLECharacteristic characteristic);
typedef void (*BLECharacteristicEventHandlerOld)(BLECentral &central, BLECharacteristic &characteristic); // deprecated
api/BLE/BLEDevice.h
@@ -30,7 +30,7 @@ enum BLEDeviceEvent {
BLEDisconnected = 2,
};

typedef void (*BLEDeviceEventHandler)(BLEDevice& device);
typedef void (*BLEDeviceEventHandler)(BLEDevice device);

This comment has been minimized.

Sign in to view
@sandeepmistry

sandeepmistry Sep 29, 2016
Author Contributor

This was a request from @tigoe (#7 (comment)).

From what I recall, the bigger discussion was related to beginners being confused by the syntax. @tigoe let me know if I missed something or didn't explain it correctly.
api/BLE/BLEPeripheral.h Outdated
enum BLEPeripheralEvent {
BLEConnected = 0,
BLEDisconnected = 1
};

This comment has been minimized.

Sign in to view
@sandeepmistry

sandeepmistry Sep 29, 2016
Author Contributor

These enums need to be removed as well, so they don't conflict with BLEDevice's.
@sandeepmistry
Correct duplicate event constants
f85a753
@sandeepmistry
Correct argument type
831da05
@facchinm facchinm force-pushed the arduino:master branch from 141b283 to 8ad0c60 Oct 30, 2018
@aentinger
Copy link
Contributor

@aentinger aentinger commented Oct 7, 2020

Probably also widely outdated @facchinm what do you think, can we close it?
@facchinm facchinm closed this Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sgbihu sgbihu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
@sandeepmistry @aentinger @sgbihu @damellis @facchinm @cmaglie
You can’t perform that action at this time.