Skip to content

Commit

Permalink
docs: add "dumb" model
Browse files Browse the repository at this point in the history
  • Loading branch information
FerroO2000 committed Jul 24, 2024
1 parent 7dda390 commit 88548c0
Showing 1 changed file with 49 additions and 6 deletions.
55 changes: 49 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,58 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/squadracorsepolito/acmelib.svg)](https://pkg.go.dev/github.com/squadracorsepolito/acmelib)
[![Go Report Card](https://goreportcard.com/badge/github.com/squadracorsepolito/acmelib)](https://goreportcard.com/report/github.com/squadracorsepolito/acmelib)

> [!IMPORTANT]
> Thi repo was moved to [squadracorse](https://github.com/squadracorsepolito/acmelib) organization.
A [Golang](https://go.dev/) package for modelling complex CAN networks.

The package documentation can be found [here](https://pkg.go.dev/github.com/FerroO2000/acmelib).

## Model

```mermaid
flowchart
subgraph Network
bus(Bus)
subgraph Node
node-int(Node Interface)
end
message(Message)
subgraph Signal
std-sig(Standard Signal)
enum-sig(Enum Signal)
mux-sig(Multiplexer Signal)
end
sig-type(Signal Type)
sig-unit(Signal Unit)
sig-enum(Signal Enum)
attribute(Attribute)
end
bus --Attaches--o node-int
node-int --Sends--o message
message -.Receives.-o node-int
message --Contains--o Signal
std-sig --o sig-type
std-sig --o sig-unit
enum-sig --o sig-enum
mux-sig --o std-sig
mux-sig --o enum-sig
mux-sig --o mux-sig
attribute -.- bus
attribute -.- Node
attribute -.- message
attribute -.- Signal
```

## Getting started

### Prerequisites
Expand All @@ -26,6 +71,4 @@ go get -u github.com/squadracorsepolito/acmelib

## TODOs

- Adding examples
- Adding JSON/Yaml and Protobuf parsing of the model
- Improving test coverage
- Adding examples

0 comments on commit 88548c0

Please sign in to comment.