Differences

This shows you the differences between two versions of the page.

--- configuration_json [ 02.12.2024 01:16] – lars
+++ configuration_json [ 23.02.2025 15:27] (current) – [project_type] lars
@@ Line 3: / Line 3: @@
 ====== File format specification of configuration definition ======
-this describes the possible elements of a configuration description in json format.
+this describes the possible elements of a configuration description in JSON format.
-The json format is defined here: https://www.json.org/json-en.html
+{{odt>toc:leader_sign=.;indents=0,0.5,1;}}
+The JSON format is defined here: https://www.json.org/json-en.html
 All elements not listed as essential are optional. Being optional means that they can be missing and the configuration is still valid.
@@ Line 59: / Line 61: @@
 Keys like *digital_output* and *SPI* represent group names and are taken from a predefined set of group names understood by MBSP. Keys nested within them are arbitrary user-defined names for a instance in that group. In those instances the keys are from the defined set specific for that group.
+===== general settings =====
+these are settings on the top layer that effect the whole project.
-===== vendor_name =====
+==== vendor_name ====
-Name of the company that sells the micro controller. As listed on chipselect.org
+Name of the company that sells the micro controller. As listed on https://chipselect.org
-type: string
+**type**: string
-===== chip_name =====
+==== chip_name ====
-model number of the micro controller.
+Model number of the micro controller. As listed on https://chipselect.org
-type: string
+**type**: string
 Model number is truncated so that it only contains relevant differences for code generation: flash and ram sizes are relevant, temperature range or package are not.
+==== project_type ====
+what type of project to generate.
+**type**: string
+**default**: "make"
+Possible values are:
+  * "hal only" : only creates the hardware driver files (in the hal/ folder) and hardware definitions (in the hal/hw/ folder)
+  * "embeetle" : create an Embeetle IDE project
+  * "make" :  creates a makefile based "blinky" project.
 ===== clock group =====
-configuration of the used cocks
+configuration of the used clocks
 TBD
@@ Line 103: / Line 123: @@
   * open drain
-type: enum
+**type**: enum
-default: push pull
+**default**: push pull
 ==== pad ====
@@ Line 111: / Line 131: @@
 defines the chip pad that the signal should be output on.
-type: string
+**type**: string
-default: no default possible
+**default**: no default possible
 ==== invert ====
@@ Line 121: / Line 141: @@
 If this setting is set to "off" (=default) then turning this output "on" will generate a High (Vcc) signal. Turning it "off" will generate a Low (Gnd) level.
-type: string
+**type**: string
-default: "off"
+**default**: "off"
@@ Line 137: / Line 157: @@
 defines the chip pad that the signal should be read from.
-type: string
+**type**: string
@@ Line 163: / Line 183: @@
 ===== UART group =====
-TBD
+This group defines all used UART interfaces.
+Each UART is a sub group with the UART name as the group name.
+<code>
+    "UART": {
+        "debug_uart": {
+            "pads": {
+              "TX": "PA5",
+              "RX": "PA6",
+              "CTS": "PA7",
+              "RTS": "PA15"
+            },
+            "bits_per_packet": "8",
+            "parity": "None",
+            "stop_bits": "1",
+            "baud_rate": "115200",
+            "hardware_flow_control": "no",
+            "receive_buffer_size": "100",
+            "send_buffer_size": "500",
+        }
+    }
+</code>
+==== pads ====
+defines the used signal pins. At least one pin must be present(either TX or RX). Pins that are not present will not be used/ are not available for functionality.
+=== TX ===
+The UART will send data on this pin. (Idle = High).
+=== RX ===
+The UART will receive (read) signals on this pin.
+=== CTS ===
+Clear to send signal for flow control.
+=== RTS ===
+Request to Send signal for flow control.
+==== bits_per_packet ====
+defines the number of data bits. Possible values are:
+  * 7
+  * 8
+  * 9
+**type**: enum
+**default**: 8
+==== parity ====
+defines the parity bit. Possible values are:
+  * None : no parity bit used.
+  * Odd :  the parity bits value makes sure that the packet contains an **__odd__** number of bits with value "1".
+  * Even : the parity bits value makes sure that the packet contains an **__even__** number of bits with value "1".
+**type**: enum
+**default**: None
+==== stop_bits ====
+defines the number of stop bits. Possible values are:
+  * 1
+  * 1,5
+  * 2
+**type**: enum
+**default**: 8
+==== baud_rate ====
+defines the number of bits send per second.
+**type**: int
+**default**: 115200
+==== hardware_flow_control ====
+defines if the Request to Send (RTS) and Clear to send (CTS) signals should be used for flow control. Possible values are:
+  * off (RTS and CTS pins are not used.
+  * RTS only
+  * CTS only
+  * on (RTS and CTS signals are used)
+**type**: enum
+**default**: off
+==== receive_buffer_size ====
+defines the number of bytes in the receive buffer of the driver.
+**type**: int
+**default**: 100
+==== send_buffer_size ====
+defines the number of bytes in the send buffer of the driver.
+**type**: int
+**default**: 500
@@ Line 306: / Line 441: @@
 TBD
-===== ... group =====
-TBD