Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.48 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.48 KB
Raw

Braiins OS+ Public API Examples

In this repository, you'll find examples in multiple programming languages, making it easier for developers with different backgrounds to get started with the Braiins OS+ Public API.

Directory Structure

The repository is organized by programming language, with each language contained in its own directory:

  • /python - Examples written in Python.
  • /go - Examples written in Go.
  • /rust - Examples written in Rust.

Each directory contains a set of examples showcasing various API interactions, from basic authentication to performing specific operations like monitoring device status or adjusting settings.

Getting Started

To get started with these examples, clone this repository to your local machine:

git clone --recurse-submodules https://github.com/braiins/bos-plus-api-demos.git

Navigate into the language-specific directory of your choice, and refer to the README.md file within that directory for language-specific setup instructions and dependencies.

Prerequisites

  • A device running Braiins OS+.
  • Basic knowledge of the programming language you wish to use.
  • An environment set up for the chosen programming language (e.g., Python, Go)

Contributing

We welcome contributions to this repository! If you have an example in a language not yet represented here, or improvements to existing examples, please feel free to submit a pull request.

Contact

For any queries or suggestions, feel free to open an issue on this repository.