Contributors Forks Stargazers Issues MIT License

Bathyx

Open source library and tray application that show battery percentage for supported devices

Report Bug · Request Feature

Table of Contents
  1. About The Project

  2. Getting Started

  3. Roadmap
  4. Contributing
  5. License

About The Project

Bathyx Screen Shot

Open source library and tray application that show battery percentage for supported devices. For now – I add devices that I have and I am using every day. If you want me to add your device, please create an request issue and I’ll check what could I do.

Implemented features:

  • Cross platform tray application with battery percentage
  • Open source library that give you ability to use device data in your project, just import this lib
  • Support HyperX Cloud Flight S headphones

(back to top)

Built With

Special thanks karalabe/hid (forked) and getlantern/systray

(back to top)

Getting Started

Application

To download application please find the latest Release and choose build for your OS.

Library

To use Bathyx as library just simply do:

  1. Get and Import app

    go get github.com/Simaky/Bathyx
    import "github.com/Simaky/Bathyx/devices"

  2. Get devices and receive information

    // new devices
d :=  devices.New()

// receive information
info := <-d.HyperX.CloudFlightS(ctx, time.Minute*1)

(back to top)

Roadmap

  • Add HyperX Cloud Flight S support
  • Add Tray application
  • Add README.md
  • Add “components” document to easily copy & paste sections of the readme
  • Support more devices

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

GitHub

View Github