diff --git a/docs/source/_static/images/charge_som_contactor_wiring.drawio.svg b/docs/source/_static/images/charge_som_contactor_wiring.drawio.svg new file mode 100755 index 0000000..c98ae66 --- /dev/null +++ b/docs/source/_static/images/charge_som_contactor_wiring.drawio.svg @@ -0,0 +1,4 @@ + + + +
PSU
12 V or 24 V DC
PSU...
DC +
DC +
precharge
precharge
−
−
+
+
AC/DC
Power Module
AC/DC...
1
1
2
2
3
3
4
4
5
5
6
6
7
7
8
8
X19
X19
DC −
DC −Text is not SVG - cannot display \ No newline at end of file diff --git a/docs/source/_static/images/charge_som_hw_wiring_diagram.svg b/docs/source/_static/images/charge_som_hw_wiring_diagram.svg new file mode 100755 index 0000000..eb038fe --- /dev/null +++ b/docs/source/_static/images/charge_som_hw_wiring_diagram.svg @@ -0,0 +1,178 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_static/images/charge_som_wiring_bender_imd.drawio.svg b/docs/source/_static/images/charge_som_wiring_bender_imd.drawio.svg new file mode 100755 index 0000000..13727f1 --- /dev/null +++ b/docs/source/_static/images/charge_som_wiring_bender_imd.drawio.svg @@ -0,0 +1,4 @@ + + + +
A
A
B
B
T/R
T/R
14
14
11
11
24
24
1
1
2
2
3
3
4
4
X9
X9
X15
X15Text is not SVG - cannot display \ No newline at end of file diff --git a/docs/source/_static/images/dc_charger_charge_som_setup.svg b/docs/source/_static/images/dc_charger_charge_som_setup.svg index 6021068..c3a51dd 100755 --- a/docs/source/_static/images/dc_charger_charge_som_setup.svg +++ b/docs/source/_static/images/dc_charger_charge_som_setup.svg @@ -1,160 +1,162 @@ - - - - - - - - - - + + + + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - - - + + + + + + - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + diff --git a/docs/source/conf.py b/docs/source/conf.py index 712bd95..5e50145 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,9 +18,12 @@ templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +numfig = True + # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output +html_title = project html_theme = 'classic' html_static_path = ['_static'] html_logo = '_static/cb_logo.png' diff --git a/docs/source/hardware.rst b/docs/source/hardware.rst new file mode 100644 index 0000000..0912d18 --- /dev/null +++ b/docs/source/hardware.rst @@ -0,0 +1,120 @@ +.. hardware.rst: + +######## +Hardware +######## + +Since the Charge SOM itself is a module which cannot be used without a carrier board, +the following sections refer to the Charge SOM Evaluation Board as an example. + + +*************** +Wiring Overview +*************** + +.. figure:: _static/images/charge_som_hw_wiring_diagram.svg + :width: 1000pt + + Figure: Wiring Overview Diagram for Charge SOM EVB + +This wiring diagram shows an overview of all components which are required at minimum +to build a DC charging station: + +* A PSU as 12V DC supply for the Charge SOM EVB +* A controllable power module (rectifier) for converting AC grid power into DC power to the EV. + In this example, this power module is connected via CAN interface to the Charge SOM EVB which + is a typical interface type for such devices. +* A DC power meter for measuring the transferred energy. In this example, this electricity meter + is connected via RS-485 bus and it is assumed that the meter supports the Modbus protocol. + However, there exists also meters which use Ethernet and other protocols. +* An insulation monitoring device (IMD). In the drawing, only the safety related connection is + shown, that means that the output pin of the IMD (which switches on insulation faults) is wired + to an input pin of the Charge SOM. The state of this input pin is observed by the onboard + safety controller of the Charge SOM which ensures a safe state of the whole system in case + of emergencies. +* The high-voltage DC contactors for DC plus and minus rails. + + +********************************** +High-Voltage Connector (HVDC, X19) +********************************** + +The X19 connector provides signals to switch the high-voltage contactors, +but also for the corresponding feedback signals to detect contactor welding. + +.. figure:: _static/images/charge_som_contactor_wiring.drawio.svg + :width: 1000pt + + Figure: Recommended Contactor Wiring + +.. note:: + The precharge contactor might not be necessary in your setup. + + +******************************************** +Insulation Monitoring Device (IMD, X9 + X15) +******************************************** + +The X9 connector and its pinout is designed to match the signals used by +Bender's ISOMETER® isoCHA425HV with AGH420-1/AGH421-1. + +In addition to the direct electrical wiring, the device has to be connected +via RS-485 bus to provide the insulation resistance values which are required +by EVerest's IMD interface. + +.. figure:: _static/images/charge_som_wiring_bender_imd.drawio.svg + :width: 1000pt + + Figure: Wiring for Bender's IMD to Charge SOM EVB + + +***************** +Safety Controller +***************** + +Overview +======== + +The Charge SOM platform is equipped with an additional MCU (aka Safety Controller) which is responsible for +managing all low-level aspects which are critical for electrical safety. The firmware for this MCU is +developed by chargebyte and is not open-source. The Charge SOM boards ship with the safety controller firmware +preinstalled. + +The host controller firmware, e.g. the Linux system, communicates with the safety controller using an UART. +On Linux side, this is UART interface ``/dev/ttyLP2``. The communication with the safety controller firmware +over this UART requires a proprietary protocol, see the following chapter. The required UART settings are listed +in the following table. + ++-----------------+-------------+ +| Setting | Value | ++=================+=============+ +| Linux Interface | /dev/ttyLP2 | ++-----------------+-------------+ +| Baudrate | 115200 | ++-----------------+-------------+ +| Databits | 8 | ++-----------------+-------------+ +| Parity | none | ++-----------------+-------------+ +| Stopbits | 1 | ++-----------------+-------------+ + + +Safety Controller Communication Protocol +======================================== + +TBD + + +EVerest Board Support Package Module +==================================== + +chargebyte developed a comprehensive hardware abstraction module (HAL, or also called BSP module - board support package) +for EVerest charging stack to support the Charge SOM platform. The module is called ``CbChargeSOMDriver`` and is +available in chargebyte's public EVerest repository as open-source code: +https://github.com/chargebyte/everest-chargebyte/tree/main/modules/CbChargeSOMDriver + +This module already implements the required communication protocol to interact with the safety controller. + +All Charge SOM boards ship with a Linux system preinstalled on eMMC, which also includes EVerest, the mentioned +BSP module and example configuration files. diff --git a/docs/source/index.rst b/docs/source/index.rst index 3885c2b..451cf8d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -20,6 +20,8 @@ Charge SOM Evaluation Kit. :caption: Contents: getting_started + peripheral_compat_list + hardware firmware everest_charging_stack cb_energy diff --git a/docs/source/peripheral_compat_list.rst b/docs/source/peripheral_compat_list.rst new file mode 100644 index 0000000..5c366de --- /dev/null +++ b/docs/source/peripheral_compat_list.rst @@ -0,0 +1,7 @@ +.. _peripheral_compat_list.rst: + +***************************** +Peripheral Compatibility List +***************************** + +.. include:: ../../includes/peripheral_compat_list.inc diff --git a/includes b/includes index 3858bc7..9b6cb50 160000 --- a/includes +++ b/includes @@ -1 +1 @@ -Subproject commit 3858bc7c8f10c5a6da92b07da742868464c8ec8b +Subproject commit 9b6cb50de07f3a2d9fab11519e14ab3555e708f6