Skip to content
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

Detailed documentation / Completed examples #148

Open
aleksastanic opened this issue Nov 22, 2024 · 5 comments
Open

Detailed documentation / Completed examples #148

aleksastanic opened this issue Nov 22, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@aleksastanic
Copy link

Is there going to be a more detailed documentation (ex. step-by-step for all functionalities) any time soon?

Also, I don't think compose multiplatform example is completed, it does not demonstrate all possiblities of this library. Is there a plan to finish it soon?

Thank you for your work!

@Reedyuk
Copy link
Owner

Reedyuk commented Nov 22, 2024

Hey,
Thanks for the feedback. The functionality is there, i guess documentation could be updated.
What more do you want the example to do?

@aleksastanic
Copy link
Author

I did not find description for any of BlueFalcon methods, how and for what they are used. I did manage to writeCharacteristic (change it's value) and readCharacteristic (read it's current value), but I don't know how to use notify or indicate characteristic. When I trigger them - descriptor is changed, but I don't know how can i subscribe to receive the characteristic value changes?

@Reedyuk
Copy link
Owner

Reedyuk commented Nov 25, 2024

The readme has some description and the website is autogenerated from it here: https://bluefalcon.dev

It should behave similar to that of the android sdk. Granted the documentation is not perfect, hence we have examples to aid understanding.

@Reedyuk Reedyuk added the documentation Improvements or additions to documentation label Jan 2, 2025
@BenMorrisRains
Copy link

Hi Reedy, I appreciate your work here. Myself and a coworker have been attempting to use the library for last few months and have made some decent headway. I would agree though that some better examples or tutorials would be great for getting people up to speed faster.

I'm not a BLE expert by any means and this library has been easier to use than others I looked at, so I think this library is on the right track. Once we are done if I am comfortable enough I wouldn't mind contributing some examples or making some YouTube videos to try to get people going faster. We have had to do a lot of self-discovery which has been informative but has taken a decent amount of time.

@Reedyuk
Copy link
Owner

Reedyuk commented Jan 12, 2025

Yes please, any contributions are welcomed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants