soundbox-go, branch v0.1.1Go library to interface with soundbox deviceshttps://cgit.xengineering.eu/soundbox-go/atom?h=v0.1.12024-10-06T16:06:29ZMove streaming example to stream_test.go2024-10-06T16:06:29Zxegineeringme@xegineering.eu2024-10-06T16:06:29Zurn:sha1:cbcebb47e515f900f2505098f0ce87697e2fe283
This example is completely based on the StreamURLContext() function.
Thus it should go to the respective test file.
Add missing doc string to public function2024-10-06T15:58:34Zxegineeringme@xegineering.eu2024-10-06T15:58:34Zurn:sha1:735a7863845da130e6c727136aac75c2e7bf23daAdd soundbox.StreamURLContext()2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T17:16:56Zurn:sha1:b8fed490c275487f14bff4f5b49a6072d27e5b5f
This should be the primary public API of the library to stream web radio
to soundbox devices.
Remove soundbox.Client2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T16:56:14Zurn:sha1:9b995e02371e45e8cb5806ee7c7eb8139bf24fd8
This data structure only contained a net.HardwareAddr and did not
provide much more useful functionality. Thus the net.HardwareAddr type
should be used directly.
Make soundbox.StreamingPort private2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T16:49:04Zurn:sha1:d246a58cb4473c7a311d99232a18057544219a9b
It is planned to provide a function for streaming. Thus the streaming
port is not required to be exposed. If there is a use case the streaming
port can be exposed again.
Add soundbox.getInterface()2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T15:28:10Zurn:sha1:56f3e2c3f47e796333d4de2502385a5ef27d049f
This is required as a temporary solution to guess the correct interface.
Rename Port to StreamingPort2024-10-02T19:55:24Zxegineeringme@xegineering.eu2024-10-02T19:53:51Zurn:sha1:9c81db35038fa96de6b3fda0695a463bbf69ac01
It is expected that further ports (maybe for information via HTTP) are
added in the future.
To keep the public API stable this should be taken into account before
the first release.
Fix example documentation2024-10-02T19:43:11Zxegineeringme@xegineering.eu2024-10-02T19:43:11Zurn:sha1:b6fa67af2c4478b99408bf919ba76a38400ee8d6Rename Soundbox to Client2024-10-02T19:18:51Zxegineeringme@xegineering.eu2024-10-02T19:18:51Zurn:sha1:07741b358ba75350e7be36ee76f45afa18b0461b
Since the module name is `soundbox` naming the primary type of the
module also `Soundbox` is redundant. Following similar code from the Go
standard library this struct is renamed to `Client`.
Fix check.py as pre-commit hook2024-10-02T19:00:25Zxegineeringme@xegineering.eu2024-10-02T19:00:25Zurn:sha1:cdd23b4b0a7c14dba738f035e75ac640f1ca3e85
The file did not work properly if used via Git commit hook symlink.
Add basic check.py2024-10-02T18:54:25Zxegineeringme@xegineering.eu2024-10-02T18:51:53Zurn:sha1:cdb89bfc9705bdee18a6893d1bb2678f6b8b7edd
This script should be usable as a Git pre-commit hook to make sure every
commit has a running test suite and is well formatted.
This commit starts with running the test suite for the module.
Add basic example2024-10-02T17:59:59Zxegineeringme@xegineering.eu2024-10-02T17:59:59Zurn:sha1:8db6c63f1bd3d4dc54dddbacf411ae6a9f33f6de
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.
Add soundbox.fromHardwareAddr()2024-10-02T16:47:34Zxegineeringme@xegineering.eu2024-10-02T16:46:50Zurn:sha1:516fa4b31da2f2a004e1c7f309c1e34803d18555
This splits the soundbox.NewSoundbox() function into two smaller
functions.
Use testing.Fatalf() to log in tests2024-10-02T14:57:10Zxegineeringme@xegineering.eu2024-10-02T14:57:10Zurn:sha1:da21e83c58b3bbc389d8919e9ca5e865e45f2751
Using testing.Errorf() does not stop the test. This was never wanted.
Add soundbox.toLinkLocal()2024-10-02T14:53:49Zxegineeringme@xegineering.eu2024-10-02T14:53:49Zurn:sha1:bc29b4a8b4629a9ef0d335325612a02a6c07b4e8
To communicate with soundbox devices it is required to convert the known
device MAC address (printed on the case) to an IPv6 link-local address.
Add soundbox.Port constant2024-10-02T13:56:21Zxegineeringme@xegineering.eu2024-10-02T13:56:21Zurn:sha1:247974c09b7e26115e9b23dc3c3402c93e17a27fLink project page in README.md2024-10-02T13:46:02Zxegineeringme@xegineering.eu2024-10-02T13:46:02Zurn:sha1:f76d4bee8263b762ddee98f5e52e8d7934a793fd
This gives a better overview of the existing repositories.
Change Go module name from `soundbox-go` to `soundbox`2024-10-02T13:31:52Zxegineeringme@xegineering.eu2024-10-02T13:31:52Zurn:sha1:4b900301a0599097d0a756344893f7630bda6feb
Go modules should be named with a single word if possible (see the
[standard libraray][1] as a reference example). Furthermore the module
name will be present in the code very often and thus length is a
critical point.
The repository and project should still be named `soundbox-go` to
distinguish it from the device repository [soundbox][2] and the
application repository [soundbox-app][3].
[1]: https://pkg.go.dev/std
[2]: https://cgit.xengineering.eu/soundbox
[3]: https://cgit.xengineering.eu/soundbox-app
Make soundbox package top-level2024-10-01T20:20:47Zxegineeringme@xegineering.eu2024-10-01T20:20:47Zurn:sha1:3fc713ccfcc96738d981a97647a84a6cb6bbec04
It is not expected that this library will be so big that multiple
packages make sense. Thus it should start only with the main package.
Add go.mod2024-10-01T19:46:13Zxegineeringme@xegineering.eu2024-10-01T19:46:13Zurn:sha1:4994a8accde17c5364e580eedc5ca1e91bf35197
This makes this repository a Go module.
Add minimal soundbox Go package2024-10-01T19:44:47Zxegineeringme@xegineering.eu2024-10-01T19:44:47Zurn:sha1:c472e5c7dee2e1cb16e297b23726a714521e8e0b
This only adds the `Soundbox` struct type which has a `net.HardwareAddr`
to identify it together with a constructor and a unit test.
Add Mozilla Public License version 2.02024-10-01T18:42:17Zxegineeringme@xegineering.eu2024-10-01T18:42:17Zurn:sha1:23f804bec8763ff832875ad8b8d57279b98fa590Add README.md with project description2024-10-01T18:38:53Zxegineeringme@xegineering.eu2024-10-01T18:38:53Zurn:sha1:917de1c9b514747a624f141950495a03e6343f3a