https://github.com/hochfrequenz/go-bo4e
BO4E Implementation in Go
https://github.com/hochfrequenz/go-bo4e
bo4e energiewirtschaft
Last synced: 6 months ago
JSON representation
BO4E Implementation in Go
- Host: GitHub
- URL: https://github.com/hochfrequenz/go-bo4e
- Owner: Hochfrequenz
- License: mit
- Created: 2021-07-23T08:15:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T06:50:21.000Z (6 months ago)
- Last Synced: 2025-04-09T09:44:55.266Z (6 months ago)
- Topics: bo4e, energiewirtschaft
- Language: Go
- Homepage:
- Size: 8.85 MB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# go-bo4e
[](https://goreportcard.com/report/github.com/Hochfrequenz/go-bo4e)
[](https://pkg.go.dev/github.com/hochfrequenz/go-bo4e)
**B**usiness **O**bjects for **E**nergy ([BO4E](https://www.bo4e.de/)) Implementation in Go. Highlights are
- includes `json` tags for easy (un)marshalling
- comes with builtin [validator](https://github.com/go-playground/validator) logic
- is linted and has decent test coverage
**This package (as of November 2021) implements**
- BO Ansprechpartner
- BO Bilanzierung (not official BO4E Standard yet)
- BO Energiemenge
- BO Geschaeftspartner
- BO Handelsunstimmigkeit (not official BO4E Standard yet)
- BO Lastgang
- BO Marktlokation
- BO Marktteilnehmer
- BO Messlokation
- BO Preisblatt
- BO Rechnung
- BO Reklamation (not official BO4E Standard yet)
- BO Vertrag
- BO Zaehler
so far.
## Installation
```
go get github.com/hochfrequenz/go-bo4e
```
## Minimal Working Example
```go
package main
import (
"encoding/json"
"fmt"
"github.com/go-playground/validator/v10"
"github.com/hochfrequenz/go-bo4e/bo"
"github.com/hochfrequenz/go-bo4e/com"
"github.com/hochfrequenz/go-bo4e/enum/botyp"
"github.com/hochfrequenz/go-bo4e/enum/landescode"
"github.com/hochfrequenz/go-bo4e/enum/sparte"
)
func main() {
melo := bo.Messlokation{
Geschaeftsobjekt: bo.Geschaeftsobjekt{
BoTyp: botyp.MESSLOKATION,
VersionStruktur: "1",
ExterneReferenzen: nil,
},
MesslokationsId: "DE0000011111222223333344444555556",
Sparte: sparte.STROM,
Messadresse: &com.Adresse{
Postleitzahl: "82031",
Ort: "Grünwald",
Strasse: "Nördliche Münchner Straße",
Hausnummer: "27A",
Landescode: landescode.DE,
},
}
vali := validator.New()
err := vali.Struct(melo)
if err == nil {
fmt.Println("The MeLo is valid.")
}
meloBytes, err := json.Marshal(melo)
meloJson := string(meloBytes)
fmt.Print(meloJson)
}
```
[Use this in the Go Playground](https://play.golang.org/p/wq8B_31Odni).
## Caveats
When serializing decimals (e.g. `Zaehlwerk.Wandlerfaktor`) you'll notice that the decimals are by default serialized as
strings
```json
{
"wandlerfaktor": "0.8"
}
```
instead of a number like
```json
{
"wandlerfaktor": 0.8
}
```
This is the default behaviour defined in
the [decimal package](https://github.com/shopspring/decimal/blob/fa3b22f4d484d626ee81919285cf3d22ad3a4000/decimal.go#L47)
. You can change the behaviour by setting
```go
decimal.MarshalJSONWithoutQuotes = true
```
as described f.e. in [issue 21 there](https://github.com/shopspring/decimal/issues/21).
## Other Noteworthy BO4E Implementations
- [C# / .NET](https://github.com/Hochfrequenz/BO4E-dotnet/)
- [Python](https://github.com/Hochfrequenz/BO4E-python/)
- [Kotlin](https://github.com/openEnWi/ktBO4E-lib)
- [TypeScript](https://github.com/openEnWi/tsBO4E-lib) (handcrafted)
- [TypeScript](https://github.com/Hochfrequenz/bo4e-dotnet-ts-models) (autogenerated from C# lib)
## Contributing
Contributions are welcome. Feel free to open a Pull Request against the main branch of this repository. Please provide
unit tests if you contribute logic beyond bare business object definitions. We do track our modification proposals
to the official BO4E standard in a separate
repository: [BO4E-modification-proposals](https://github.com/Hochfrequenz/bo4e-modification-proposals).
### Adding Enums
When adding Enums there are two packages ([stringer](https://pkg.go.dev/golang.org/x/tools/cmd/stringer)
, [jsonenums](https://github.com/campoy/jsonenums)) needed to go-generate additional files, which contain an
implementation of the `fmt.Stringer` and `json.Marshaler` interface for the respective enum. Since they are just needed
for the code generation, but not a real dependency we don't want them in the go.mod file. One way to install them is
outside of your directory with:
```
go install github.com/campoy/jsonenums@latest
go install golang.org/x/tools/cmd/stringer@latest
```
## Hochfrequenz
[Hochfrequenz Unternehmensberatung GmbH](https://www.hochfrequenz.de) is a Grünwald (near Munich) based consulting
company with offices in Berlin and Bremen. We're not only the main contributor to open source BO4E software but,
according to [Kununu ratings](https://www.kununu.com/de/hochfrequenz-unternehmensberatung1), also among the most
attractive employers within the German energy market. Applications of talented developers are welcome at any time!
Please consider visiting
our [career page](https://www.hochfrequenz.de/index.php/karriere/aktuelle-stellenausschreibungen/full-stack-entwickler) (
German only).