Die App wird über mehrere JSON-Files konfiguriert:
Die JSON-Files können sie mit einem Editor ihrer Wahl wie beispielsweise Notepad++ oder VS Code editieren.
Um Änderungen wirksam zu machen bitte nach dem Editieren eine laufende Instanz mit dem reinit-Command re-initialisieren.
Die app-Config besteht aus einem JSON-Object mit dem Key data. Alle weiteren Properties sind Keys dieses Objects.
{
"data": {
"logs": {
"level": "debug",
"file": {
"enabled": true,
"maxFiles": 10,
"name": "disco-io.log"
},
"singleline": true,
"syslog": {
"address": "127.0.0.1",
"enabled": false,
"facility": 16,
"newline": true,
"port": 514
}
}
}
}
Settings für das Logging.
| Key | Typ | Beschreibung | Default | Erforderlich |
|---|---|---|---|---|
| enabled | boolean | aktiviert File-Logging | false |
✖️ |
| maxFiles | number | Maximale Anzahl an Log-Files | 10. | ✖️ |
| name | string | Basis-Name für Log-Files | disco-io.log |
✖️ |
Der Ordner in dem die Log-Files angelegt werden ist entweder der Default-Pfad oder der beim Start durch Default-Pfad festgelegte.
Ist die Property singleline auf falsegesetzt, werden die Log-Messages als Newline-Delimited-JSONs ausgegebn. Der Default ist false.
| Key | Typ | Beschreibung | Default | Erforderlich |
|---|---|---|---|---|
| address | string | Netwerk-Name oder IP-Adresse des Syslog-Servers | 127.0.0.1 |
✖️ |
| enabled | boolean | Logging aus Syslog aktivieren | false |
✖️ |
| facility | number | Syslog-Facility | 16 | ✖️ |
| newline | boolean | Newline am Ende jeder Log-Message einfügen | true |
✖️ |
| port | number | Port auf dem der Syslog-Server hört. | 514 | ✖️ |
Die params-Config besteht aus einem JSON-Array mit dem Key data, welches die Parameter-Defintionen enthält.
{
"data": [
{
"id": "BOOLEAN",
"props": {
"defaultVal": true
},
"type": "Boolean"
},
{
"id": "NUMBER",
"props": {
"defaultVal": 0
},
"type": "Number"
},
{
"id": "SELECTOR",
"props": {
"defaultIndex": 0,
"items": [
"item_0",
"item_1",
"item_2"
]
},
"type": "Selector"
},
{
"id": "STRING",
"props": {
"defaultVal": "I am a string"
},
"type": "String"
}
]
}
Alle Parameter-Types haben die gemeinsame Properties:
| Prop | Beschreibung | Erforderlich |
|---|---|---|
| type | Type des Parameters, mögliche Werte sind Boolean, Number, Selector und String |
✔️ |
| id | Geben Sie dem Parameter eine ID, diese muss eindeutig sein | ✔️ |
| label | Geben Sie dem Parameter ein Label, dieses muss eindeutig sein, optional | ✖️ |
| Prop | Type | Description | Beschreibung | Erforderlich |
|---|---|---|---|---|
| defaultVal | number | Default val | false |
✖️ |
{
"id": "BOOL",
"label": "Bool",
"props": {
"defaultVal": true
},
"type": "Boolean"
}
| Prop | Type | Beschreibung | Default | Erforderlich |
|---|---|---|---|---|
| defaultVal | number | Default val | 0 |
✖️ |
| maximum | number | Maximum val, optional | - | ✖️ |
| minimum | number | Minimum val, optional | - | ✖️ |
| multipleOf | number | Nur Vielfaxche von, optional | - | ✖️ |
{
"id": "NUMBER",
"props": {
"defaultVal": 10,
"maximum": 100,
"minimum": -100,
"multipleOf": 2
},
"type": "Number"
}
| Prop | Type | Beschreibung | Default | Erforderlich |
|---|---|---|---|---|
| defaultIndex | number | Default Index | 0 |
✖️ |
| items | array | Items | [] |
✖️ |
{
"id": "SELECTOR",
"props": {
"defaultIndex": 0,
"items": ["item_0", "item_1", "item_2", "item_3"]
},
"type": "Selector"
}
| Prop | Type | Beschreibung | Default | Erforderlich |
|---|---|---|---|---|
| defaultVal | string | Default-val | NO STRING |
✖️ |
| options | string[] | Liste valider Strings, optional | - | ✖️ |
| pattern | number | RegExp für valid String-Patterns, optional | - | ✖️ |
{
"id": "STRING",
"props": {
"defaultVal": "Servus"
},
"type": "String"
}