First Upload

Author: bergmanu

LICENSE.md

@@ -0,0 +1,26 @@
+# **Legal information**
+
+## **Use of application examples**
+
+Application examples illustrate the solution of automation tasks through an interaction of several components in the form of text, graphics and/or software modules. The application examples are a free service by Siemens AG and/or a subsidiary of Siemens AG (“Siemens”). They are non-binding and make no claim to completeness or functionality regarding configuration and equipment. The application examples merely offer help with typical tasks; they do not constitute customer-specific solutions. You yourself are responsible for the proper and safe operation of the products in accordance with applicable regulations and must also check the function of the respective application example and customize it for your system.
+
+Any change to the application examples is your responsibility. The application examples are not required to undergo the customary tests and quality inspections of a chargeable product; they may have functional and performance defects as well as errors. It is your responsibility to use them in such a manner that any malfunctions that may occur do not result in property damage or injury to persons. Siemens reserves the right to make changes to the application examples at any time without notice. The application examples of this repository are licensed under the MIT License (see below).
+
+## **MIT License**
+
+Copyright 2021 Siemens AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## **Security information**
+
+Siemens provides products and solutions with industrial security functions that support the secure operation of plants, systems, machines and networks. In order to protect plants, systems, machines and networks against cyber threats, it is necessary to implement – and continuously maintain – a holistic, state-of-the-art industrial security concept. Siemens’ products and solutions constitute one element of such a concept. Customers are responsible for preventing unauthorized access to their plants, systems, machines and networks. Such systems, machines and components should only be connected to an enterprise network or the Internet if and to the extent such a connection is necessary and only when appropriate security measures (e.g. firewalls and/or network segmentation) are in place.  
+For additional information on industrial security measures that may be implemented, please visit [https://www.siemens.com/industrialsecurity](https://www.siemens.com/industrialsecurity).
+
+Siemens’ products and solutions undergo continuous development to make them more secure. Siemens strongly recommends that product updates are applied as soon as they are available and that the latest product versions are used. Use of product versions that are no longer supported, and failure to apply the latest updates may increase customer’s exposure to cyber threats.
+
+To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed at: [https://www.siemens.com/industrialsecurity](https://www.siemens.com/industrialsecurity).

README.md

@@ -0,0 +1,54 @@
+# **IOT2050-Example-Serial-Modbus-Connection**
+
+- [**IOT2050-Example-Serial-Modbus-Connection**](#iot2050-example-serial-modbus-connection)
+  - [**Overview**](#overview)
+  - [**Hardware**](#hardware)
+  - [**Software**](#software)
+  - [**Prepare the IOT2050 & Examples**](#prepare-the-iot2050--examples)
+  - [**Related Links**](#related-links)
+  - [**Contribution**](#contribution)
+  - [**License and Legal Information**](#license-and-legal-information)
+
+## **Overview**
+
+This application shows two ways to exchange data via a serial port between PC (Windows/Linux) and the IOT2050. In the first example a pure serial transmission is used, while in the second example the communication protocol Modbus RTU is used additionally.
+
+![Overview](docs/graphics/overview.png)
+
+## **Hardware**
+
+The following hardware components are required for the application:
+
+- **SIMATIC IOT2050 Advanced or Basic**
+- **USB to Serial Converter** (in this example: DIGITUS USB 2.0 to serial Converter, RS485 incl. USB A Cable 80cm)##
+
+## **Software**
+
+- **Example 1: Virtual Machine with Linux OS on Windows PC:** In this example VMWare Workstation 16 Player and Linux Debian 10 is used
+  - working internet connection on the VM
+  - install **picocom** with the terminal-command 'sudo apt-get install picocom' (in this manual version 3.1 is used)
+- **Example 2: PyModSlave on Windows PC:** You can download it [here](https://pypi.org/project/pyModSlave/) (in this manual version 0.4.4 is used)
+
+## **Prepare the IOT2050 & Examples**
+
+You can find the instructions for preparing the IOT2050 and the both examples in the following links:
+
+- [**Prepare the IOT2050**](docs/README-Prepare-the-IOT2050.md)
+- [**Example 1: Sending ASCII-characters using a serial connection**](docs/README-Example-1.md)
+- [**Example 2: Sending array-packages using modbus-protocol**](docs/README-Example-2.md)
+
+## **Related Links**
+
+||Topic|
+|-|-|
+|1|SIMATIC IOT2050 forum: [https://support.industry.siemens.com/tf/ww/en/threads/309](https://support.industry.siemens.com/tf/ww/en/threads/309)|
+|2|SIMATIC IOT2050 Getting Started: [https://support.industry.siemens.com/tf/ww/en/posts/238945/](https://support.industry.siemens.com/tf/ww/en/posts/238945/)|
+|3|Operating Instructions: [https://support.industry.siemens.com/cs/ww/en/view/109779016](https://support.industry.siemens.com/cs/ww/en/view/109779016)|
+
+## **Contribution**
+
+Thanks for your interest in contributing. Anybody is free to report bugs, unclear documenation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.
+
+## **License and Legal Information**
+
+Please read the [Legal information](LICENSE.md).

docs/README-Example-1.md

@@ -0,0 +1,47 @@
+# **Example 1: Sending ASCII-characters using a serial connection**
+
+Make sure the following nodes are activated in Node-Red (the modbus-nodes must be deactivated):
+
+![Example 1 Node-Red](graphics/nodered-example-1.png)
+
+You can enable/disable nodes as follows: Double-Click on the node -> Change Enabled / Disabled -> Click Done -> Press Deploy to apply the changes
+
+Open the Virtual Machine on your PC connected to the IOT2050. If not already done, open a terminal and install picocom (in this manual version 3.1 is used) with the following command:
+
+    sudo apt-get install picocom
+
+With the following command you can then check if the installation was successful:
+
+    which picocom
+
+The terminal should show the output on the image:
+
+![Picocom success](graphics/check-picocom.png)
+
+Remove the USB to serial converter from your PC and plug it in again. Make sure that the USB device now connects to the virtual machine. The following message appears in VMWare Workstation 16 Player:
+
+![device detected](graphics/device-detected.png)
+
+Start picocom with the following command:
+
+    sudo picocom /dev/ttyUSB0 -c -b 115200
+
+## **Sending from Virtual Machine to IOT2050**
+
+Once picocom is ready, characters can be entered and then transmitted. The split input timeout is set to 2000ms by default. The output can then be viewed in Node-Red under "debug messages".
+
+![sending serial from VM to IOT2050](graphics/sending-serial-vm-to-iot2050.png)
+
+## **Sending from IOT2050 to Virtual Machine**
+
+Make sure that picocom is enabled so that a signal can be received. Then, in node-red, the output can be triggered by clicking on the inject-node. The text "Example-123" is configured in the inject-node by default.
+
+![sending serial from IOT2050 to VM](graphics/sending-serial-iot2050-to-vm.png)
+
+You can exit the picocom-command by pressing CTRL+A and CTRL+Q.
+
+## **Other documents**
+
+- [**Application-Overview**](../README.md)
+- [**Prepare the IOT2050**](README-Prepare-the-IOT2050.md)
+- [**Example 2: Sending array-packages using modbus-protocol**](README-Example-2.md)

docs/README-Example-2.md

@@ -0,0 +1,43 @@
+# **Example 2: Sending array-packages using modbus-protocol**
+
+At the beginning, please make sure that the USB to Serial converter is connected directly to your PC and not passed through to a VM (especially if [**Example 1**](README_Example_1) was done before).
+
+If not already done install PyModSlave on your Windows PC: You can download it [here](https://pypi.org/project/pyModSlave/) (in this manual version 0.4.4 is used).
+
+Make sure the following nodes are activated in Node-Red (the serial-in/out-nodes must be deactivated):
+
+![Example 2 Node-Red](graphics/nodered-example-2.png)
+
+You can enable/disable nodes as follows: Double-Click on the node -> Change Enabled / Disabled -> Click Done -> Press Deploy to apply the changes
+
+## **Sending from PC to IOT2050**
+
+Open the application pyModSlave -> Click the "Modbus RTU" settings-button -> Adjust the settings as in the following picture -> Press "OK"
+
+![pyModSlave Modbus RTU Settings](graphics/pymodslave-modbus-rtu-settings.png)
+
+Now switch to the "Input Registers" tab -> Click the "Connect"-button -> The connection should now be displayed as active (green circle at the bottom left) -> The numerical values of the sending array can now be adjusted as desired
+
+![pyModSlave connecting](graphics/pymodslave-connecting.png)
+
+The modbus-in node in Node-Red should now receive this array and output it via the debug node:
+
+![Modbus Input Node-Red](graphics/modbus-in-output-node-red.png)
+
+The transmission can be terminated by clicking the connect-button again.
+
+## **Sending from IOT2050 to PC**
+
+Open the application pyModSlave -> Click the "Modbus RTU" settings-button -> Adjust the settings as in the following picture -> Press "OK"
+
+![pyModSlave Modbus RTU Settings](graphics/pymodslave-modbus-rtu-settings.png)
+
+Now switch to the "Holding Registers" tab -> Click the "Connect"-button -> The connection should now be displayed as active (green circle at the bottom left) -> Then, in node-red, the output can be triggered by clicking on the inject-node. The array "[1,2,3,4" is configured in the inject-node by default. -> In pyModSlave you can now see how the first registers has adapted
+
+![sending modbus from IOT2050 to pyModSlave](graphics/sending-modbus-iot2050-to-pymodslave.png)
+
+## **Other documents**
+
+- [**Application-Overview**](../README.md)
+- [**Prepare the IOT2050**](README-Prepare-the-IOT2050.md)
+- [**Example 1: Sending ASCII-characters using a serial connection**](README-Example-1.md)

docs/README-Prepare-the-IOT2050.md

@@ -0,0 +1,72 @@
+# **Prepare the IOT2050**
+
+## **Installing Example-Image & First commissioning**
+
+Follow [SIMATIC_IOT2050_Setting_up.md](https://github.com/SIMATICmeetsLinux/IOT2050-SmartFarming-Application/blob/main/docs/SIMATIC_IOT2050_setting_up.md) for the following steps:
+
+- Installing the SD-Card Example Image (in this example the image V1.1.1 was used)
+- First commissioning of the SIMATIC IOT2050: Remote access with Putty SSH Connection (login as root)
+- Network connection to open Node-Red
+
+## **Adjust Peripherals on IOT2050 Basic**
+
+Use the following command to get into the setup:
+
+    iot2050setup
+
+Perform the following steps:
+
+    Peripherals -> Configure External COM Ports -> RS485 -> Select "Turn on terminate resistor" (spacebar) -> Confirm with "Ok" -> Confirm the Changes -> Exit setup-menu and reboot the IOT2050
+
+## **Adjust Peripherals on IOT2050 Advanced**
+
+Use the following command to get into the setup:
+
+    iot2050setup
+
+Perform the following steps:
+
+    Peripherals -> Configure External COM Ports -> RS485 -> Select "Turn on terminate resistor" (spacebar) -> Confirm with "Ok"
+
+The setup- and hold-values must be adjusted as follows (0x0005):
+
+![adjust setup- and hold-values](graphics/setupholdtime.png)
+
+    Confirm with "Ok" -> Cornfim again with "Ok"
+
+![power cycle IOT2050 Advanced](graphics/power-cycle-iot2050.png)
+
+**Important:** After the changes to the **IOT2050 Advanced**, it is **essential to perform a manual reboot**: To do this, disconnect the power cable from the device for a few seconds and reconnect it. A conventional reboot is not sufficient for this!
+
+## **Connect the hardware-devices**
+
+Connect the computer and the IOT2050 using the USB to serial converter. Make sure that the pins are assigned correctly. The pin assignment on the IOT2050 is as follows:
+
+![serial connection](graphics/serial-connection.png)
+
+For more information please visit the [SIMATIC IOT2050 support page](https://support.industry.siemens.com/cs/document/109779016/simatic-iot2050).
+
+**Important:** Please also pay attention to the pinout of your converter!
+
+## **Import Node-Red Flow**
+
+On the Example Image version 1.1.1 (used in this manual) Node-Red is already preinstalled and autostart is enabled. To access it, open a browser on your PC connected to the IOT2050 and open the URL `http://<IP of the IOT2050>:1880/`.
+
+Download the ready-made JSON-File: [iot2050-example-serial-modbus-connection.json](../src/iot2050-example-serial-modbus-connection.json)
+Import the flow and press the "deploy-button":
+
+    Menu -> Import -> Select a file to import -> Press the Import-Button
+
+If all configurations are set correctly, the flow will look like the following.
+
+![overview node-red](graphics/overview-node-red.png)
+
+Depending on the IOT2050 (basic or advanced) used, the appropriate flow must be selected and activated:
+
+    Double-Click on the basic-/advanced-tab -> Change "Disabled" to "Enabled" -> Click Done -> Press Deploy to apply the changes
+
+## **Other documents**
+
+- [**Application-Overview**](../README.md)
+- [**Example 1: Sending ASCII-characters using a serial connection**](README-Example-1.md)
+- [**Example 2: Sending array-packages using modbus-protocol**](README-Example-2.md)