From 8db6c63f1bd3d4dc54dddbacf411ae6a9f33f6de Mon Sep 17 00:00:00 2001 From: xegineering Date: Wed, 2 Oct 2024 19:59:59 +0200 Subject: Add basic example This gives a brief introduction how the library should be used. Furthermore it has an output string comment making sure with the test suite that it actually works. --- examples_test.go | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 examples_test.go (limited to 'examples_test.go') diff --git a/examples_test.go b/examples_test.go new file mode 100644 index 0000000..1320cd6 --- /dev/null +++ b/examples_test.go @@ -0,0 +1,21 @@ +package soundbox_test + +import ( + "fmt" + "log" + + "xengineering.eu/soundbox" +) + +// ExampleSoundbox demonstrates how to instantiate a Soundbox struct. The used +// MAC address if from a private range according to +// https://www.rfc-editor.org/rfc/rfc9542.html#name-48-bit-mac-documentation-va. +func ExampleSoundbox() { + s, err := soundbox.NewSoundbox("00:00:5E:00:53:01") + if err != nil { + log.Fatal(err) + } + + fmt.Printf("Soundbox with MAC address %v", s.HardwareAddr) + // Output: Soundbox with MAC address 00:00:5e:00:53:01 +} -- cgit v1.2.3-70-g09d2