Skip to content

Commit

Permalink
start an interface documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
XdoctorwhoZ committed Jun 21, 2024
1 parent 511f1af commit 7359e5c
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 32 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "platform_error"
description: ""
weight: 1
weight: 20
icon: "error"
---

Expand Down
20 changes: 20 additions & 0 deletions content/docs/50_platform/architecture/interface/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Interface"
description: "How are organized the interfaces ?"
weight: 1
icon: "arrow_forward_ios"
---


Interfaces are mainly composed of

- Interface Data
- FSM (Finite State Machine): Manage internal workflow of the interface
- Listener: manage incoming message from the connection

FSM et Listener have their own task.

Other helper components:

- Logger: Helper to log information that come from this specific interface

30 changes: 0 additions & 30 deletions content/docs/50_platform/architecture/introduction/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Platform Services"
description: ""
weight: 1
weight: 10
icon: "rule_settings"
---

Expand Down
24 changes: 24 additions & 0 deletions content/docs/50_platform/architecture/synoptic/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,27 @@ icon: "architecture"
![](./schema.png)



The platform sources are coded in Rust and are organized by directory reflecting its architecture.

## builtin_devices

This directory contains devices and interface implementations that come built-in the main platform sources.

In this directory there must be one directory for each manufacturer. The manufacturer directory must hold devices related to its produc
ts.

## Meta

In the meta directory, you will find generic interface implementations.
Those implementations ease the adaptations of new device interfaces by taking care of most of the hard part of the behavior and letting to the user only the specific callback to implement.


## Log

In the log directory, you will find how traces of the application are managed.

### class

Traces in rust can take some attributes. Panduza has defined the log attribute “class” to sort event sources in the application.

0 comments on commit 7359e5c

Please sign in to comment.