King Pigeon BL101 User Manual
King Pigeon BL101 User Manual

King Pigeon BL101 User Manual

Modbus iot gateway
Table of Contents

Advertisement

Quick Links

Modbus IoT Gateway
BL101
BL101
User Manual
Revision: V1.0
Issue Date: 2021-6-1
King Pigeon Communication Co., Ltd
Website: www.iot-solution.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the BL101 and is the answer not in the manual?

Questions and answers

Summary of Contents for King Pigeon BL101

  • Page 1 Modbus IoT Gateway BL101 BL101 User Manual Revision: V1.0 Issue Date: 2021-6-1 King Pigeon Communication Co., Ltd Website: www.iot-solution.com...
  • Page 2 Copyright This user manual is owned by King Pigeon Communication Co., Ltd. No one is authorized to copy, distribute or forward any part of this document without written approval of King Pigeon.
  • Page 3: Table Of Contents

    4.1.1 Open Configuration Software..............19 4.1.2 Search for Device..................20 4.1.3 Connect Gateway Device................21 4.2 Configuration Software Introduction..............22 4.2.1 System Function.................... 22 4.2.2 COM Port Introduction.................. 24 4.2.2.1 COM Port Configuration................ 24 King Pigeon Communication Co., Ltd. Page 3 of 76 V1.0 www.iot-solution.com...
  • Page 4 4.2.9.3 Alibaba Cloud..................45 4.2.9.4 HUAWEI Cloud..................46 4.2.9.5 AWS (Amazon Web Service)..............48 4.2.9.6 King Pigeon Cloud via MQTT...............51 4.2.9.7 King Pigeon Cloud via Modbus............52 5 BL101 Gateway Application Example...............53 5.1 Device Connecting Diagram................53 King Pigeon Communication Co., Ltd.
  • Page 5 5.2.2.10 View Data from AWS................69 5.2.2.11 King Pigeon Cloud via Modbus Configuration......... 70 5.2.2.12 View Data from King Pigeon Cloud via Modbus......71 5.2.2.13 King Pigeon Cloud via MQTT Configuration........72 5.2.2.14 View Data from King Pigeon Cloud via MQTT........ 73 5.2.2.15 King Pigeon Cloud MQTT Message Format........73...
  • Page 6: Brief Introduction To Device

    1 Brief Introduction to Device 1.1 General Description Developed on embedded Linux operation system for robust stability, BL101 is an innovative gateway that converts Modbus to OPC UA / MQTT protocol. It’s equipped with 1RS232/RS485(default RS485) serial port, 2 power source inputs, 1 power output, 2 Ethernet ports and 2 USB ports.
  • Page 7: Application Scenario

    Modbus to MQTT IoT Gateway -BL101 1.2 Application Scenario 1.3 Packing List Before operating the device, please make sure all below parts are in the package King Pigeon Communication Co., Ltd. Page 7 of 76 V1.0 www.iot-solution.com...
  • Page 8 1x 4PIN 3.5mm terminal for power input  1x RS485/232 5PIN 3.5mm terminal for power output  1 x 4G SMA Cellular Network Antenna  2 x Wall-mounting Clip Kit  King Pigeon Communication Co., Ltd. Page 8 of 76 V1.0 www.iot-solution.com...
  • Page 9 1 x Data Card Picking PIN  1 x Product Qualification Certificate  1 x Warranty Card  Note: If any of the above items are missing, please contact King Pigeon Sales team. King Pigeon Communication Co., Ltd. Page 9 of 76 V1.0 www.iot-solution.com...
  • Page 10: Features

    Metal case with IP30 protection grade. Safety isolation between metal case and  system , especially suitable for industrial site applications Compact size: 30mm*83mm*110mm; Support wall-mounting and DIN rail  mounting King Pigeon Communication Co., Ltd. Page 10 of 76 V1.0 www.iot-solution.com...
  • Page 11: Technical Parameters

    1* program downloading+1*program debugging USB Port Spec Micro USB OTG Protection Over Current Protection Antenna Qty Antenna Type GSM/EDGE:900,1800MHz WCDMA:B1,B5,B8 L-E version FDD-LTE:B1,B3,B5,B7,B8,B20 (Optional) TDD-LTE:B38,B40,B41 GSM/EDGE:900,1800MHz WCDMA:B1,B8 L-CE version TD-SCDMA:B34,B39 FDD-LTE:B1,B3,B8 King Pigeon Communication Co., Ltd. Page 11 of 76 V1.0 www.iot-solution.com...
  • Page 12 EN 55022: 2006/A1: 2007 (CE &RE) Class B Safety IEC 61000-4-2 (ESD) Level 4 Certification IEC 61000-4-3 (RS) Level 4 IEC 61000-4-4 (EFT) Level 4 IEC 61000-4-5 (Surge)Level 3 King Pigeon Communication Co., Ltd. Page 12 of 76 V1.0 www.iot-solution.com...
  • Page 13: Model Selection

    POE PD (RS485/RS232 optional) BL101 √ √ √ √ Optional BL101E √ √ √ Optional BL101UA √ √ √ √ Optional 2 Hardware Introduction 2.1 Outline Dimension Unit: mm King Pigeon Communication Co., Ltd. Page 13 of 76 V1.0 www.iot-solution.com...
  • Page 14: Power Source Input

    Modbus to MQTT IoT Gateway -BL101 2.2 Power Source Input 2 optional power source input channels, support 9-36VDC voltage input, support King Pigeon Communication Co., Ltd. Page 14 of 76 V1.0 www.iot-solution.com...
  • Page 15: Sim Card And Sd Card Slots

    DEBUG USB port is for program debugging. DOWNLOAD USB port is for program upgrading. 2.5 Device Grounding Before connecting the device, please do equipment grounding with grounding screw to prevent electromagnetic interference King Pigeon Communication Co., Ltd. Page 15 of 76 V1.0 www.iot-solution.com...
  • Page 16: Antenna

    No data is received in serial port Note: RUN indicator will be on if device is powered. If it’s not on, please check whether there’s reverse wiring or power source problem. King Pigeon Communication Co., Ltd. Page 16 of 76 V1.0...
  • Page 17: Reset Button

    Power Output Positive Terminal VOUT- Power Output Negative Terminal B/RX RS485 Data-(B)/Receiving Data A/TX RS485 Data+(A)/Transmitting Data Grounding Note: Power output voltage is equal to power input voltage: 9~36VDC. King Pigeon Communication Co., Ltd. Page 17 of 76 V1.0 www.iot-solution.com...
  • Page 18: Wan & Lan Port

    10Mbps mode Connected Link Yellow Flickering Transferring data Disconnected 3 Device Mounting BL101 Gateway can be placed on desk, mounted on the wall and DIN Rail 3.1 Wall-Mounting Wall-Mounting King Pigeon Communication Co., Ltd. Page 18 of 76 V1.0 www.iot-solution.com...
  • Page 19: Din Rail Mounting

    Connect BL101 to router or switch through WAN port with standard direct network cable or cross network cable. Make sure BL101 and PC are in the same local area network. If it’s necessary to connect the gateway to PC directly, use standard cross network cable to connect through BL101 LAN port.
  • Page 20: Search For Device

    PC. If no device is found, please follow the procedure on the right notice box to check the root cause. Below is the example of connecting Gateway BL101 with switch through WAN. A device with IP 192.168.1.165 is searched out.
  • Page 21: Connect Gateway Device

    Double click the device to be configured (For example, double click device with IP 192.168.1.165) . Reading success message will be shown in prompting box. Click confirm to enter configuration page. King Pigeon Communication Co., Ltd. Page 21 of 76 V1.0...
  • Page 22: Configuration Software Introduction

    4.2 Configuration Software Introduction 4.2.1 System Function System Function Item Description Device Search Search for all BL101 gateways in the same loca area network New Configuration Open a new default configuration file Import Configuration File Import gateway configuration file Export Configuration File...
  • Page 23 SIM Registration Red indicates SIM card is registered. Status Gray indicates SIM card is not registered, King Pigeon Cloud Red indicates King Pigeon cloud is connected via Modbus via Modbus Online Gray indicates King Pigeon cloud is unconnected via Status Modbus...
  • Page 24: Com Port Introduction

    Serial “57600”, “115200” Port Select “1Bit” or “2Bit” Stop Bit 1Bit Settings Select “7Bit” or “8Bit” 8Bit Data Bit Select “None”, “Even” ,“Odd” None Parity Bit Confirm COM configuration King Pigeon Communication Co., Ltd. Page 24 of 76 V1.0 www.iot-solution.com...
  • Page 25: Add Com Port Devices

    For the added device, double click it to show device configuration information. Right click to delete device。 Note: Maximum 50 Modbus RTU devices’ data can be collected through COM King Pigeon Communication Co., Ltd. Page 25 of 76 V1.0...
  • Page 26: Add Com Port Device Datapoints

    Click Add to enter datapoint configuration box. Right click the added datapoint to delete it. Double click the datapoint to edit it. To add more datapoints, right click the box and perform the same procedures. King Pigeon Communication Co., Ltd. Page 26 of 76 V1.0...
  • Page 27 Starting Address Datapoint address Select from Bool, 16-bit unsigned integer, 16-bit signed integer, Data Type 32-bitunsigned integer, 32-bit signed integer, 32-bit single precision floating point Add Number Datapoint qty King Pigeon Communication Co., Ltd. Page 27 of 76 V1.0 www.iot-solution.com...
  • Page 28: Lan Port Introduction

    Double click LAN port to enter setting page. Factory default IP of LAN is 192.168.3.1. Auto IP address distribution and routing functions are turned off from factory setting in default King Pigeon Communication Co., Ltd. Page 28 of 76 V1.0...
  • Page 29: Add Lan Port Device

    4.2.3.2 Add LAN Port Device Right click LAN and clik Add to enter device configuration page. Device can be connected directly with Gateway BL101 through LAN or through switch which is connected with LAN. Note: Total 50 devices can be connected through LAN and WAN King Pigeon Communication Co., Ltd.
  • Page 30 Device Brand Modbus Device Model Modbus TCP Modbus communication address LAN port device Station ID 16-bit Data Type Select “AB” or “BA” 32-bit Data Type Select“ABCD”, “DCBA”, “BADC” or “CDAB” King Pigeon Communication Co., Ltd. Page 30 of 76 V1.0 www.iot-solution.com...
  • Page 31: Add Lan Port Device Datapoints

    Current IP Address of WAN Port Subnet Mask Current WAN Subnet Mask Gateway Current WAN Gateway Address MAC Address WAN port MAC address Current WAN port DNS server Confirm WAN port setting King Pigeon Communication Co., Ltd. Page 31 of 76 V1.0 www.iot-solution.com...
  • Page 32: Add Wan Port Device

    Right click WAN and then click add to enter device configuration page More devices can be connected with switch connecting WAN port Note: Total 50 Modbus TCP devices can be connected through LAN and WAN WAN Port Device Configuration King Pigeon Communication Co., Ltd. Page 32 of 76 V1.0 www.iot-solution.com...
  • Page 33: Add Wan Port Device Datapoints

    Double click 4G to enter APN setting box. Note: It’s not necessary to set APN for China mainland 4G network. If no 4G module in the device, it’s not needed to set it either King Pigeon Communication Co., Ltd. Page 33 of 76 V1.0...
  • Page 34: Alarms And Events Configuration

    4.2.6 Alarms and Events Configuration Double click Alarms and Events to enter setting box. Alarm points, actions and alarm recovery actions can be set according to requirement 4.2.6.1 Alarm Points Configuration King Pigeon Communication Co., Ltd. Page 34 of 76 V1.0 www.iot-solution.com...
  • Page 35: Alarm Event Configuration

    Right click Alarm Trigger Action box and click Add to enter Event configuration box for setting actions to be performed when alarm is triggered. Right click Alarm Release Action box to set actions to be performed when alarm is released King Pigeon Communication Co., Ltd. Page 35 of 76 V1.0...
  • Page 36 Write Point Name Click Add, select datapoint and click OK to confirm. Double click datapoint to view its attributes Write Value Write datapoint value. For Boolean value, select 1 or 0 King Pigeon Communication Co., Ltd. Page 36 of 76 V1.0 www.iot-solution.com...
  • Page 37: Task Plan Configuration

    Set time to perform the planned task (UTC time) Week Set week day to perform the planned task Write Point Name Write Point Name will be generated based on selected King Pigeon Communication Co., Ltd. Page 37 of 76 V1.0 www.iot-solution.com...
  • Page 38: Data Service

    Confirm Task Plan setting Cancel Cancel Task Plan setting 4.2.8 Data Service 4.2.8.1 Transparent Transmission Set COM mode to Transparent Transmission, set COM parameters and then configure Transparent Transmission parameters King Pigeon Communication Co., Ltd. Page 38 of 76 V1.0 www.iot-solution.com...
  • Page 39: Modbus Rtu To Modbus Tcp

    COM1 Mode Selection Select Gateway as “TCP Server” or “TCP Client” Only set it when BL101 Gateway is used as TCP server Select Network Port Select WAN or LAN If BL101 is used as server, it can’t be set but...
  • Page 40 TCP Server (Gateway can only be TCP Server) Select Network Port Select “WAN” or “LAN” Monitoring Port Input port of monitoring BL101 Gateway (required) Confirm Modbus RTU to Modbus TCP configuration Cancel Cancel Modbus RTU to Modbus TCP configuration King Pigeon Communication Co., Ltd.
  • Page 41: Modbus Tcp Server

    Cancel Cancel Modbus TCP Server setting 4.2.8.4 OPC UA BL101 Gateway supports OPC UA protocol and provides data as OPC UA server Note: Only the model which supports OPC UA needs this configuration King Pigeon Communication Co., Ltd. Page 41 of 76 V1.0...
  • Page 42: Cloud Platform Connection

    Cancel Cancel OPC UA setting 4.2.9 Cloud Platform Connection BL101 Gateway supports device online in multiple cloud platforms simultaneously. 4.2.9.1 MQTT Client One MQTT Client One can be connected to cloud with certificate or without certificate King Pigeon Communication Co., Ltd.
  • Page 43 User Name of MQTT Connecting message. User Name Server uses it for ID verification and authorization Password of MQTT Connecting message Password Server uses it for ID verification and authorization King Pigeon Communication Co., Ltd. Page 43 of 76 V1.0 www.iot-solution.com...
  • Page 44: Mqtt Client Two

    MQTT Client Two subscribe topic does not work. MQTT Client Two is used for viewing data from cloud but not controlling data MQTT Client Two Configuration refer to MQTT Client One King Pigeon Communication Co., Ltd. Page 44 of 76 V1.0 www.iot-solution.com...
  • Page 45: Alibaba Cloud

    Default is blank box with all datapoints to be uploaded Publish Datapoint Right click the box and click Add to select datapoint for Selection uploading. Click OK to confirm it. King Pigeon Communication Co., Ltd. Page 45 of 76 V1.0 www.iot-solution.com...
  • Page 46: Huawei Cloud

    Note: Datapoint box is blank in default which means all datapoints will be uploaded. If there’re multiple Service IDs, only one Service ID datapoint box can be blank. Datapoints for uploading must be selected for other Service IDs. King Pigeon Communication Co., Ltd. Page 46 of 76 V1.0...
  • Page 47 Default is connecting with Secret Key. Click it to move the button Secret Key/X.509 on the right for connecting with Certificate Device ID Set the same ID as the one in HUAWEI Cloud(Device-Device ID) King Pigeon Communication Co., Ltd. Page 47 of 76 V1.0 www.iot-solution.com...
  • Page 48: Aws (Amazon Web Service)

    Confirm HUAWEI Cloud setting Cancel Cancel HUWEI Cloud setting 4.2.9.5 AWS (Amazon Web Service) Note: Datapoint box is blank in default which means all datapoints will be published. If King Pigeon Communication Co., Ltd. Page 48 of 76 V1.0 www.iot-solution.com...
  • Page 49 Gray indicates AWS is disabled. Default is disabled Input ASW Connection Endpoint (Enter Console, click Things and then click Interact to get it) Server IP/ Domain Name Server Port 8883 (Required) Item Name Input Thing ARN King Pigeon Communication Co., Ltd. Page 49 of 76 V1.0 www.iot-solution.com...
  • Page 50 Default is blank box with all datapoints to be published Datapoint Publishing Right click the box and click Add to select datapoint for Selection publishing. Click OK to confirm it.。 Confirm AWS setting Cancel Cancel AWS setting King Pigeon Communication Co., Ltd. Page 50 of 76 V1.0 www.iot-solution.com...
  • Page 51: King Pigeon Cloud Via Mqtt

    Gray indicates King Pigeon cloud via MQTT is disabled Server IP/Domain Name mqtt.dtuip.com Server Port 1883(Required) Input device serial number issued by King Pigeon Client ID (Contact King Pigeon sales to get the serial number if required to connect to King Pigeon cloud) User Name MQTT Password MQTTPW...
  • Page 52: King Pigeon Cloud Via Modbus

    Confirm King Pigeon Cloud via MQTT setting Cancel Cancel King Pigeon Cloud via MQTT setting 4.2.9.7 King Pigeon Cloud via Modbus Both King Pigeon Cloud and customized Clouds can be connected via Modbus RTU protocol. King Pigeon Cloud via Modbus Item...
  • Page 53: Bl101 Gateway Application Example

    Modbus to MQTT IoT Gateway -BL101 5 BL101 Gateway Application Example BL101 COM port connects remote IO module M140T and collects its data through Modbus RTU protocol. BL101 LAN port connects network switch N81 and multi-functional RTU S475 connects N81 switch. S475 data is collected through Modbus TCP protocol.
  • Page 54: Configuration Software Setting

    (4) Baud rate, Stop bit, Data Bit and Parity Bit will be set the same as that in M140T RS485 port (5) Click OK to confirm Note: Click Save Data. Gateway will restart automatically. COM configuration will be valid after device restarting King Pigeon Communication Co., Ltd. Page 54 of 76 V1.0 www.iot-solution.com...
  • Page 55: Add M140T To Com Port

    Click COM1 to view the added device M140T. If more devices to be added, perform the same procedures as above Step (1)-(5) Note: Click Save Data. Gateway BL101 will restart automatically. After restarting, M140T is added successfully. King Pigeon Communication Co., Ltd.
  • Page 56: Add M140T Datapoints

    (9) Modbus Mapping Address: Input the address where the collected datapoint is saved in BL101. It can be any address from 0-2000 but can’t be repeated. For example, DO1 data is saved in register address 0 of BL101 (10) MQTT Flag: can be any identification mark, but can’t be repeated...
  • Page 57: Lan Port Configuration

    Note: LAN Port IP Address specifies the IP address arrange of LAN port device. If device IP address is not within the range, data can’t be collected. Thus it’s necessary King Pigeon Communication Co., Ltd. Page 57 of 76 V1.0...
  • Page 58: Add Lan Port Device S475

    502. Thus put 502 (5) Device Brand: Modbus; Device Model: Modbus TCP (BL101 collects S475 through LAN port through Modbus TCP protocol) (6) Station ID: 1, (S475 Modbus ID is 1) (7) Select Data Type. For example, S475 power source and temperature & humidity data is 16-bit AB type, 32-bit data is not collected.
  • Page 59: Add S475 Datapoint

    To add more datapoints, right click the box and click Add to enter configuration box. Perform the same procedure as Step (2)-(11) Note: Click Save Data. Gateway will restart automatically. After device restarting, S475 datapoint is added successfully. King Pigeon Communication Co., Ltd. Page 59 of 76 V1.0 www.iot-solution.com...
  • Page 60: M140T & S475 Data Uploading To Clouds

    King Pigeon Cloud via Modbus. MQTT Client One and MQTT Client Two are for private cloud, supporting connecting with certificate. The settings are the same as King Pigeon Cloud connection via MQTT. Thus it will not be described here. 5.2.2.1 Modbus TCP Server Configuration...
  • Page 61: Opc Ua Configuration

    Modbus to MQTT IoT Gateway -BL101 collect data from BL101, like SCADA, MES PCs. Below example is simulating KEPServerEX 6 as host computer to collect BL101 data. 5.2.2.3 OPC UA Configuration (1) Double click OPC UA to enter configuration box (2) Click Enable to enable(green color) OPC UA.
  • Page 62: View Data With Kepserverex 6

    (10) Click Save Data. Gateway will restart automatically. Afer device restarting, OPC UA is configured successfully. 5.2.2.4 View Data with KEPServerEX 6 BL101 provides data as OPC UA server. Use KEPServerEX 6 to view collected data as below picture: King Pigeon Communication Co., Ltd.
  • Page 63: Alibaba Cloud Configuration

    If indicator button is red, it means device is connected with Alibaba cloud. Slave device connection status can be viewed from the right box King Pigeon Communication Co., Ltd. Page 63 of 76 V1.0...
  • Page 64: View Data From Alibaba Cloud

    Modbus to MQTT IoT Gateway -BL101 5.2.2.6 View Data from Alibaba Cloud King Pigeon Communication Co., Ltd. Page 64 of 76 V1.0 www.iot-solution.com...
  • Page 65: Huawei Cloud Configuration

    (5) Secret Key/X.509: click it to move the button on the right to set connecting with certificate. In default the button is on the left with setting of connecting with secret King Pigeon Communication Co., Ltd. Page 65 of 76 V1.0...
  • Page 66 HUAWEI Cloud connection status can be viewed from basic information. Red indicates device is connected with HUAWEI Cloud. On the right side, slave device connection status can be viewed King Pigeon Communication Co., Ltd. Page 66 of 76 V1.0 www.iot-solution.com...
  • Page 67: View Data From Huawei Cloud

    Modbus to MQTT IoT Gateway -BL101 5.2.2.8 View Data from HUAWEI Cloud King Pigeon Communication Co., Ltd. Page 67 of 76 V1.0 www.iot-solution.com...
  • Page 68: Aws Configuration

    (4) Server Port: 8883 (5) Item Name: Input thing ARN(Click Details of Thing to view ARN in AWS) (6) Client ID: Input AWS Account ID (view from user information in AWS) King Pigeon Communication Co., Ltd. Page 68 of 76 V1.0...
  • Page 69: View Data From Aws

    5.2.2.10 View Data from AWS Login to ASW, click Act, click Test and select subscription topic “iot/topic” to view messages published by BL101 gateway King Pigeon Communication Co., Ltd. Page 69 of 76 V1.0...
  • Page 70: King Pigeon Cloud Via Modbus Configuration

    (10) Heatbeat Interval: Set cycle time of sending heatbeat message. Default is 60s (11) Click OK to confirm the configuration. (12) Click Save Data. Gateway will restart and King Pigeon Cloud via Modbus is enabled successfully. Open configuration software and login device. King Pigeon cloud via Modbus connection status can be viewed from basic information.
  • Page 71: View Data From King Pigeon Cloud Via Modbus

    Modbus to MQTT IoT Gateway -BL101 5.2.2.12 View Data from King Pigeon Cloud via Modbus King Pigeon Communication Co., Ltd. Page 71 of 76 V1.0 www.iot-solution.com...
  • Page 72: King Pigeon Cloud Via Mqtt Configuration

    (13) Click OK to confirm King Pigeon Cloud via MQTT configuration (14) Click Save Data. Gateway will restart and King Pigeon Cloud via MQTT is configured successfully. Open configuration software and login the device. King Pigeon Cloud connection status via MQTT can be viewed from basic information.
  • Page 73: View Data From King Pigeon Cloud Via Mqtt

    5.2.2.14 View Data from King Pigeon Cloud via MQTT 5.2.2.15 King Pigeon Cloud MQTT Message Format MQTT Client One , MQTT Client Two and King Pigeon Cloud MQTT data formats are the same. See below: (1) Valid Load Data Format in device Publishing messages Publish Topic: Serial Number (Configured publish topic) "sensorDatas": [...
  • Page 74 //Read-Wrie Mark:character is "flag", followed by " Datapoint MQTT flag", it’s the MQTT mark set in configuration software when adding datapoint. //Data Type and Value: Boolean data: character is "switcher", followed by "0" or "1"(0 represents open, 1 represents close) King Pigeon Communication Co., Ltd. Page 74 of 76 V1.0 www.iot-solution.com...
  • Page 75 (2) Valid Load Data Format in device Subscribing messages Subscribe Topic: Serial Number/+ (Subscribe topic set in configuration software) (King Pigeon cloud message publishing topic is “serial number/sensor ID”, thus wildcard “/+” must be added for device Subscribing Topic so that cloud can publishing data for controlling) "sensorDatas":...
  • Page 76: Firmware Upgrading

    Modbus to MQTT IoT Gateway -BL101 6 Firmware Upgrading Please contact King Pigeon if it’s necessary to upgrade firmware for any new requirements 7 Warranty Term 1) Warranty period is 1 year from the date of purchase. If any quality issues within warranty period, it will be repaired for free.

Table of Contents