Categorygithub.com/basilfx/go-ble-berrylan
modulepackage
0.0.0-20200921191027-a40c1e2d7f28
Repository: https://github.com/basilfx/go-ble-berrylan.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
6
Dependents
0
Files
515 SLOC

# README

go-ble-berrylan

Golang implementation of the BerryLan BLE server for go-ble

Introduction

This library implements the BerryLan BLE server protocol. It can be used to commission WiFi settings for a(n) (IoT) device.

Although BerryLan is tailored towards NetworkManager, it could be used with other networking applications too.

Dependencies

This library makes use of go-ble. Currently, it only runs on Linux.

Examples

An example application is included that provides a 'dummy' implementation of a backend. It can be used together with the BerryLan application ( Apple App Store, Google Play Store).

To run this example, navigate to the examples/dummy folder, and run go run main.go. Root access may be necessary to access the Bluetooth peripheral.

License

See the LICENSE.md file (MIT license).

# Packages

No description provided by the author

# Functions

NewNetworkService initializes a new NetworkService.
NewWirelessService initializes a new WirelessService.

# Constants

NetworkStatus enum values.
NetworkStatus enum values.
NetworkStatus enum values.
NetworkStatus enum values.
NetworkStatus enum values.
NetworkStatus enum values.
NetworkStatus enum values.
NetworkStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.
WirelessConnectionStatus enum values.

# Structs

ConnectionInfo struct.
NetworkInfo struct.
NetworkService represents the BLE wireless service.
WirelessService represents the BLE wireless service.

# Interfaces

Interface is a combined interface of WirelessInterface and NetworkInterface, for convenience reasons.
NetworkInterface is the interface for communicating with the (system) networking service.
WirelessInterface is the interface for managing the wireless connection.

# Type aliases

ConnectionStatusUpdateHandler event handler function.
NetworkingStateUpdateHandler event handler function.
NetworkStatus enum type.
NetworkStatusUpdateHandler event handler function.
WirelessConnectionStatus enum type.
WirelessStateUpdateHandler event handler function.