|
1 | 1 | # BytebeamArduino
|
2 |
| -This library provies a client for connecting ESP devices to [Bytebeam](https://bytebeam.io/) IoT platform |
3 | 2 |
|
4 |
| -## Features |
5 |
| -- Efficiently send data to cloud. |
6 |
| -- Receive commands from the cloud, execute them and update progress of execution. |
7 |
| -- Download Firmware images from cloud in case of OTA updates being triggered from cloud. |
| 3 | +<div> |
| 4 | + <img alt="Bytebeam Arduino Logo" src="docs/logo.png" /> |
| 5 | +</div> |
| 6 | + |
| 7 | +This library provides a simple client for connecting ESP devices to [Bytebeam](https://bytebeam.io/) IoT platform. |
8 | 8 |
|
9 | 9 | ## What's included in the Library :-
|
10 | 10 |
|
11 | 11 | - **src** :- This section contains source code for various functions that can be used by applications for interacting with Bytebeam platform.
|
12 | 12 | - **examples** :- This folder conatins few example sketch which demonstrates establishing secure connection with Bytebeam platform. Also, it demonstrates periodic data pushing and receiving actions.
|
13 | 13 |
|
14 | 14 | ## Dependencies :-
|
15 |
| -- [Arduinojson](https://github.com/bblanchon/ArduinoJson) |
16 | 15 | - [PubSubClient](https://github.com/knolleary/pubsubclient)
|
| 16 | +- [Arduinojson](https://github.com/bblanchon/ArduinoJson) |
| 17 | +- [NTPClient](https://github.com/arduino-libraries/NTPClient) |
17 | 18 | - Core SDK ( [ESP32](https://github.com/espressif/arduino-esp32) or [ESP8266](https://github.com/esp8266/Arduino) )
|
18 | 19 | - Dev Board ( ESP32 or ESP8266 )
|
19 | 20 |
|
20 | 21 | We recommend to install the latest versions of the libraries and Core SDK.
|
21 | 22 |
|
22 |
| -## Library Setup and Integration :- |
23 |
| -This Library can be integrated with new as well as existing Arduino ESP32 or Arduino ESP8266 sketches. Follow the [instruction guide](https://github.com/bytebeamio/BytebeamArduino/blob/main/README.md) for setting up and integrating library with your Arduino sketch. |
| 23 | +## Getting Started :- |
| 24 | +This Library can be integrated with new as well as existing Arduino ESP32 or Arduino ESP8266 sketches. Follow the [instruction guide](https://bytebeam.io/docs/arduino) for setting up and integrating library with your Arduino sketch. |
| 25 | + |
| 26 | +## Features |
| 27 | +- Efficiently send data to cloud. |
| 28 | +- Receive commands from the cloud, execute them and update progress of execution. |
| 29 | +- Download Firmware images from cloud in case of OTA updates being triggered from cloud. |
| 30 | + |
| 31 | +## Community |
| 32 | + |
| 33 | +- Follow us on [Twitter](https://twitter.com/bytebeamhq) |
| 34 | +- Connect with us on [LinkedIn](https://www.linkedin.com/company/bytebeam/) |
| 35 | +- Read our official [Blog](https://bytebeam.io/blog/) |
| 36 | + |
| 37 | +## Contributing |
| 38 | +Please follow the [code of conduct](CODE_OF_CONDUCT.md) while opening issues to report bugs or before you contribute fixes, also do read our [contributor guide](CONTRIBUTING.md) to get a better idea of what we'd appreciate and what we won't. |
| 39 | + |
| 40 | +## License |
| 41 | + |
| 42 | +This project is released under The Apache License, Version 2.0 ([LICENSE](./LICENSE) or http://www.apache.org/licenses/LICENSE-2.0) |
0 commit comments