README
¶
Model Garage
Welcome to the Model Garage, a Golang toolkit for managing and working with DIMO models generated from vspec CSV schemas. Model Garage provides the following features:
Features
- Model Creation: Create models from vspec CSV schemas, represented as Go structs.
- JSON Conversion: Easily convert JSON data for your models with automatically generated and customizable conversion functions.
Signal Definitions
Signal definitions can be found in the spec package. This package is the source of truth for signals used for DIMO Data.
Migrations
To create a new migration, run the following command:
Make migration name=<migration_name>
This will create a new migration file the given name in the migrations directory.
this creation should be used over the goose binary to ensure expected behavior of embedded migrations.
Repo structure
Codegen
The codegen directory contains the code generation tool for creating models from vspec CSV schemas. The tool is a standalone application that can be run from the command line.
Example usage:
go run github.com/DIMO-Network/model-garage/cmd/codegen -generators=custom -custom.output-file=./pkg/vss/vehicle-structs.go -custom.template-file=./internal/generator/vehicle.tmpl -custom.format=true
codegen is a tool to generate code for the model-garage project.
Available generators:
- custom: Runs a given golang template with pkg/schema.TemplateData data.
- convert: Generates conversion functions for converting between raw data into signals.Usage:
-convert.copy-comments
Copy through comments on conversion functions. Default is false.
-convert.output-file string
Output file for the conversion functions. (default "convert-funcs_gen.go")
-convert.package string
Name of the package to generate the conversion functions. If empty, the base model name is used.
-custom.format
Format the generated file with goimports.
-custom.output-file string
Path of the generate gql file (default "custom.txt")
-custom.template-file string
Path to the template file. Which is executed with codegen.TemplateData data.
-definitions string
Path to the definitions file if empty, the definitions will be used
-generators string
Comma separated list of generators to run. Options: convert, custom. (default "all")
-spec string
Path to the vspec CSV file if empty, the embedded vspec will be used
Generation Info
The codegen tool is typically used to create files based on arbitrary signal definitions. The tool reads the signal definitions and custom templates and executes the templates to create the output files.
Custom Generator
The custom generator takes in a custom template file and output file. The template file is a Go template that is executed with the signal definitions. The data struct passed into the template is defined by pkg/schema/signal.go.(TemplateData) see vehicle.tmpl for an example template.
Convert Generator
The convert generator is a built-in generator that creates conversion functions for each signal. The conversion functions are created based on the signal definitions. The conversion functions are meant to be overridden with custom logic as needed. When generation is re-run, the conversion functions are not overwritten.
Typical use cases
Updating mappings
- Update the signal name to VSS name mappings in definitions.yaml.
- run
make generate - PR and github release
Make the mappings take across our pipeline
- In the https://github.com/DIMO-Network/benthos-plugin/ repo, update the
go.modversion for the model-garage dependency. - PR and github release
- In the https://github.com/DIMO-Network/stream-es repo, in
values.yamlupdate the containerimage.tagto point to the latest benthos-plugin release commit hash (copy it from release view). - Push to main, then go to argo to sync it to prod
- In the https://github.com/DIMO-Network/telemetry-api/ repo, update the
go.modversion for the model-garage dependency. - PR and github release
- argo to sync it to prod
Add signals to DIMO VSS spec
This is when the COVESA standard does not have a signal for something we get from an external integration.
- Look at this repo: https://github.com/DIMO-Network/VSS/blob/main/overlays/DIMO/dimo.vspec and follow readme there.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
clickhouse-container
Package main is a binary for creating a test ClickHouse container.
|
Package main is a binary for creating a test ClickHouse container. |
|
codegen
Package main provides the entrypoint for the code generation tool.
|
Package main provides the entrypoint for the code generation tool. |
|
migrate
Package main is the entry point to run goose CLI with model-garage migrations.
|
Package main is the entry point to run goose CLI with model-garage migrations. |
|
internal
|
|
|
generator/convert
Package convert provides a function to generate conversion functions for a vehicle struct.
|
Package convert provides a function to generate conversion functions for a vehicle struct. |
|
generator/custom
Package custom provides the custom generation functionality that uses a provide template to generate a file.
|
Package custom provides the custom generation functionality that uses a provide template to generate a file. |
|
pkg
|
|
|
cloudevent
Package cloudevent provides types for working with CloudEvents.
|
Package cloudevent provides types for working with CloudEvents. |
|
codegen
Package codegen provides the code generation functionality for converting VSPEC signals to Go structs and ClickHouse tables.
|
Package codegen provides the code generation functionality for converting VSPEC signals to Go structs and ClickHouse tables. |
|
convert
Package convert provides common functions for handling signal conversion.
|
Package convert provides common functions for handling signal conversion. |
|
lorawan
Package lorawan provides types for working with LoRaWAN payloads.
|
Package lorawan provides types for working with LoRaWAN payloads. |
|
migrations
Package migrations provides the functionality for managing database migrations for the vss tables.
|
Package migrations provides the functionality for managing database migrations for the vss tables. |
|
nativestatus
Package nativestatus provides a function to generate conversion functions for a vehicle struct.
|
Package nativestatus provides a function to generate conversion functions for a vehicle struct. |
|
nativestatus/schema
Package schema information for converting native dimo status objects
|
Package schema information for converting native dimo status objects |
|
runner
Package runner is a package that provides a programmatic interface to the code generation tool.
|
Package runner is a package that provides a programmatic interface to the code generation tool. |
|
ruptela
Code generated by github.com/DIMO-Network/pkg/ruptela/codegen DO NOT EDIT.
|
Code generated by github.com/DIMO-Network/pkg/ruptela/codegen DO NOT EDIT. |
|
ruptela/fingerprint
Package fingerprint provides decoding for Ruptela fingerprint payloads.
|
Package fingerprint provides decoding for Ruptela fingerprint payloads. |
|
ruptela/schema
Package schema contains the embedded schema files for the ruptela devices
|
Package schema contains the embedded schema files for the ruptela devices |
|
ruptela/status
Package status provides a funcions for managing Ruptela status payloads.
|
Package status provides a funcions for managing Ruptela status payloads. |
|
schema
Package schema contains the types and functions for generating the schema from the spec and definition files.
|
Package schema contains the types and functions for generating the schema from the spec and definition files. |
|
tesla
Code generated by github.com/DIMO-Network/model-garage DO NOT EDIT.
|
Code generated by github.com/DIMO-Network/model-garage DO NOT EDIT. |
|
tesla/status
Package status converts Tesla CloudEvents to ClickHouse-ready slices of signals.
|
Package status converts Tesla CloudEvents to ClickHouse-ready slices of signals. |
|
twilio
Package twilio provides structures and methods to interact with Twilio data types.
|
Package twilio provides structures and methods to interact with Twilio data types. |
|
version
Package version provides the version of the application.
|
Package version provides the version of the application. |
|
vss
Package vss holds the data structures and functions for working with signals from DIMOs VSS schema.
|
Package vss holds the data structures and functions for working with signals from DIMOs VSS schema. |