Differences

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

--- configuration_json [ 18.12.2024 00:54] – [hardware_flow_control] 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.
 {{odt>toc:leader_sign=.;indents=0,0.5,1;}}
-The json format is defined here: https://www.json.org/json-en.html
+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 61: / 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
-===== chip_name =====
+==== chip_name ====
-model number of the micro controller.
+Model number of the micro controller. As listed on https://chipselect.org
 **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.
@@ Line 177: / Line 195: @@
               "CTS": "PA7",
               "RTS": "PA15"
-            }
+            },
-            "bits_per_packet": "8"
+            "bits_per_packet": "8",
-            "parity": "None"
+            "parity": "None",
-            "stop_bits": "1"
+            "stop_bits": "1",
-            "baud_rate": "115200"
+            "baud_rate": "115200",
-            "hardware_flow_control": "no"
+            "hardware_flow_control": "no",
-            "receive_buffer_size": "100"
+            "receive_buffer_size": "100",
-            "send_buffer_size": "500"
+            "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 ====
@@ Line 236: / Line 276: @@
 defines if the Request to Send (RTS) and Clear to send (CTS) signals should be used for flow control. Possible values are:
-  * no (RTS and CTS pins are not used.
+  * off (RTS and CTS pins are not used.
   * RTS only
   * CTS only
-  * yes (RTS and CTS signals are used)
+  * on (RTS and CTS signals are used)
 **type**: enum
-**default**: no
+**default**: off
 ==== receive_buffer_size ====
@@ Line 401: / Line 441: @@
 TBD
-===== ... group =====
-TBD