TDC‐E Network Configuration
Welcome to the TDC-E Network Configuration section! Here, the process of connecting your TDC-E to the network and similar services is described. See the list of described configurations below:
The TDC-E device provides a Local Area Network (LAN) interface for networks. In this section of the documentation, the process of connecting your device to a LAN will be described. First, the setup of the physical environment will be discussed. Afterwards, an example of connecting the TDC-E device to a LAN will described. Lastly, REST API commands for working with the WLAN interface will be provided.
In this section, the setup of the physical environment that is needed for data receiving and transmission over a Local Area Network is described.
To be able to connect to a LAN, an Ethernet cable has to be connected to the TDC-E device. See the picture below for more details.
The TDC-E's front has four connection plugs on the front. Eth can be configured on points labeled 3 and 4. Their parameters and intended usage is listed in the table below.
| Label | Ethernet | Usage | Factory IP Address |
|---|---|---|---|
| 3 | Eth0 | Connecting Ethernet-capable sensors Connecting a configuration PC |
192.168.0.100 |
| 4 | Eth1 | Sending data via LAN | assigned by DHCP |
In this section, setting up the wireless network interface on the TDC-E is described. To set up your TDC-E to connect to a specific WLAN, go to SICK's Device Manager and find the Network card from the drop-down menu on the left side of the screen. Here, go to the LAN menu. The following screen should be visible:
The LAN menu shows all available interfaces, their segments, their enabled and connection status and activity in bytes. To enable or disable a device, simply check the Enabled option and the device should respond accordingly.
NOTE: Ports can be configured under the Network tab in the Segments menu.
In this section, a list of REST APIs for working with the LAN interface is provided.
GET/networking/lan
GET/networking/lan/{lan}
GET/networking/lan/{lan}/details
GET/networking/lan/{lan}/statistics
PUT/networking/lan/{lan}
{
"segment": "string",
"segmentType": "wan",
"name": "string",
"type": "bridge",
"enabled": true,
"state": "connected"
}
The TDC-E device provides a WLAN interface for networks. In this section of the documentation, the process of connecting your device to a wireless LAN will be described. First, the setup of the physical environment will be discussed. Afterwards, an example of connecting the TDC-E device to a WLAN via WiFi will described. Lastly, REST API commands for working with the WLAN interface will be provided.
In this section, the setup of the physical environment that is needed for data receiving and transmission over WiFi is described.
To be able to connect to WiFi, a WLAN antenna is needed. The WLAN antenna is labeled with a 1 on the picture below. The WLAN isn't mounted at the factory and must be screwed on by turning it clockwise before commissioning the devices.
After attaching the antenna, you can proceed to the network configuration.
In this section, setting up the wireless network interface on the TDC-E is described. To set up your TDC-E to connect to a specific WLAN, go to SICK's Device Manager and find the Network card from the drop-down menu on the left side of the screen. Here, go to the WLAN menu. The following screen should be visible:In this section, setting up the wireless network interface on the TDC-E is described. To set up your TDC-E to connect to a specific WLAN, go to SICK's Device Manager and find the Network card from the drop-down menu on the left side of the screen. Here, go to the WLAN menu. The following screen should be visible:
The Operating Mode of the interface can be configured to client or Access Point. To set up the interface, select your operating mode and set the Status to Enabled.
Set the Periodic Scan interval in the Client area and Enable it. The TDC-E device will now scan the area for wireless networks every X seconds, depending on the provided number. Your screen should now look like this:
The SSID, Quality of the connection, Encryption method, Connection status, Auto reconnection and Edit fields for each available wireless network is listed.
To connect to a network, select it on the left, then click Connect. The site will now ask you for a Security key. Insert the security key and select Connect. The connection is now established.
NOTE: If the connection is interrupted during operation, the TDC-E automatically attempts to reconnect via the Auto reconnect option. When the device is restarted, the WLAN will be connected automatically using the last SSID if there is no Ethernet connection available.
To set up the Access Point area, configure the WLAN access point via SSID, the network key and the channel number.
NOTE: The access point can be configured via the Segments tab.
In this section, a list of REST APIs for working with the WLAN interface is provided.
GET/networking/wlan
GET/networking/wlan/{wlan}
GET/networking/wlan/{wlan}/details
GET/networking/wlan/{wlan}/statistics
GET/networking/wlan/{wlan}/scans
GET/networking/wlan/{wlan}/networks/{ssid}
PUT/networking/wlan/{wlan}/networks
{
"state": "connected",
"ssid": "string",
"username": "string",
"passphrase": "string",
"reconnect": true
}
POST/networking/wlan/{wlan}/networks
{
"state": "connected",
"ssid": "string",
"username": "string",
"passphrase": "string",
"reconnect": true
}
PUT/networking/wlan/{wlan}
{
"name": "string",
"segment": "string",
"segmentType": "wan",
"enabled": true,
"state": "connected",
"ap": {
"enabled": true,
"hidden": true,
"restricted": true,
"channel": 0,
"encryption": "string",
"passphrase": "string",
"ssid": "string"
}
}
PUT/networking/wlan/{wlan}/scans
{
"active": true,
"interval": 0,
"duration": 0
}
This is the documentation of the usage and setup of a modem on the TDC-E device. In the first section, the physical environment setup for using a modem will be described. Next, network configuration of the modem will be covered. Lastly, REST API call addresses will be listed and code working with frequent REST API addresses will be provided.
In this section, the setup of the physical environment that is needed for data receiving and transmission over a modem is described. To set up a physical environment in which a modem is used, a SIM card needs to be inserted into the TDC-E. To do so, go through the following steps:
- Remove the four screws on the bottom of the TDC-E device
- Open the lid
- Find the SIM compartment on the board and insert SIM card
- Screw lid back on
NOTE: Make sure to unplug the TDC-E power supply for safety reasons.
The SIM card is now inserted, and the physical environment is set up. For sending a message from the TDC-E's modem to another device, a SIM card on another device is required.
NOTE: The messages sent to the TDC-E are stored on the SIM card of the device. This SIM card can store up to 20 messages.
In this section, setting up the modem interface on the TDC-E is described. To set up your TDC-E to set up a modem, go to SICK's Device Manager and find the Network card from the drop-down menu on the left side of the screen. Here, go to the Modem menu. The following screen should be visible:In this section, setting up the modem interface on the TDC-E is described. To set up your TDC-E to set up a modem, go to SICK's Device Manager and find the Network card from the drop-down menu on the left side of the screen. Here, go to the Modem menu. The following screen should be visible:
The modem menu shows the Status, Provider and Details data. For the Provider, you can set up an APN (Access Point Name) for your interface, the username, password and dial string for it. You can apply the set parameters selecting the Apply button. The Details entail the device state, whether the GSM is registered, the IMEI, CCID, IMSI, Signal Level and the Activity of the device.
To enable using the modem, turn the Status on.
NOTE: The modem interface cannot be connected if WLAN is active. If WLAN is connected, a pop up will appear on the manager, issuing a warning that WLAN needs to be disabled for the modem to work.
NOTE: The specific modem device name is usually ppp0.
To connect to the device, select Connect in the Details section of the panel. The following screenshot depicts a successfully connected environment:
In this section, a list of REST APIs for working with the modem interface is provided.
GET/networking/modem
GET/networking/modem/{modem}
GET/networking/modem/{modem}/details
GET/networking/modem/{modem}/apn
GET/networking/modem/{modem}/statistics
GET/networking/modem/{modem}/messages
PUT/networking/modem/{modem}
{
"segment": "string",
"segmentType": "wan",
"persist": true,
"name": "string",
"type": "bridge",
"enabled": true,
"state": "connected"
}
PUT/networking/modem/{modem}/apn
{
"apn": "string",
"user": "string",
"password": "string",
"dialString": "string"
}
POST/networking/modem/{modem}/sms/messages
{
"phoneNumber": "string",
"content": "string"
}
In this section, setting up the DNS (Domain Name System) is discussed. Firstly, network configuration is discussed, and afterwards REST API queries and settings are displayed.
To set up a DNS server, which is responsible for assigning domain names for IP addresses, go to Device Manager and find the Network card from the drop-down menu on the left side of the screen. Here, go to the DNS menu. The following screen should be visible:
To specify a domain name and IP address for the DNS server, provide the needed parameters for the service and select the plus icon.
GET/networking/dns
GET/networking/dns/status
PUT/networking/dns
{
"domainName": "string",
"domainNameServers": [
"string"
]
}