Copyright©2025 Yonyou Group All rights reserved.Without the written permission of Yonyou Group, no part or whole of the content of this user manual may be copied, reproduced, translated, or reduced for any purpose. The content of this user manual may change without notice, please be aware.Please note: The content of this user manual does not represent the commitments made by Yonyou.Operation GuideMQTT Access StandardsContextThe AIoT Data Access Specification is provided by Yonyou's AIoT Development Department for the scenario of connecting IoT devices to the AIoT cloud platform, aimed at helping customers quickly and securely complete the device cloud access.Network TopologyAIoT cloud platform supports two connection methods: 1. Edge Gateway: AIoT Edge Gateway (with built-in agent functionality) collects data from edge devices and reports it to the AIoT cloud platform via MQTT agreement. 2. External Gateway: Supports third-party gateway devices to connect, and through permission adaptation and message authentication, data can be reported to the AIoT cloud platform via MQTT agreement;Noun ExplanationNounDescriptionModelA collection of devices, usually referring to a group of devices with the same functionality. The AIoT cloud platform issues a globally unique ProductKey for each model.GatewayA device that can directly connect to the AIoT cloud platform and has sub-device management capabilities, able to proxy sub-device connections to the cloud.DeviceA specific device that belongs to a certain model.Sub-deviceEssentially also a device. Sub-devices cannot connect directly to the AIoT cloud platform and can only connect through a gateway.Device TupleThe device tuple refers to the combination of ProductKey, DeviceKey, and DeviceSecret. ProductKey: A globally unique identifier issued by the AIOT cloud platform for the model. This parameter is very important and will be used in device authentication and communication, so it needs to be kept safe. DeviceKey: A custom or system-generated device key that is unique within the model dimension when registering the device. This parameter is very important and will be used in device authentication and communication, so it needs to be kept safe. DeviceSecret: The device key issued by the IoT platform for the device, paired with DeviceKey. This parameter is very important and will be used in device authentication, so it needs to be kept safe and must not be disclosed.ProductSecretThe model key issued by the AIOT cloud platform, usually paired with ProductKey, and can be used for one-to-one authentication schemes. This parameter is very important and needs to be kept safe and not disclosed.MQTTMessage Queuing Telemetry Transport, a lightweight communication protocol based on the publish/subscribe model, built on the TCP/IP protocol. The greatest advantage of MQTT is that it can provide real-time reliable messaging services for connecting remote devices with minimal code and limited bandwidth. As a low-overhead, low-bandwidth instant messaging protocol, it has a wide range of applications in IoT, small devices, mobile apps, etc.TopicA UTF-8 string that serves as a transmission intermediary for publishing (Pub) and subscribing (Sub) messages. Messages can be published to or subscribed from a Topic.Thing ModelA description of the device's functionality in the cloud, including the device's properties, services, and events.FunctionThe function defines these three dimensions of the thing model, describing what the entity is, what it can do, and what information it can provide externally from the perspectives of properties, services, and events.Data FormatThe data accessed by the AIoT cloud platform complies with the standard MQTT format, and the messages use Protobuf serialization.SubjectReporting Subjectapi/v1/device/02532011-92da-4199-af7c-1981aabc027c/message/reportDataAmong them, 02532011-92da-4199-af7c-1981aabc027c is the device ID.Message Content// Protobuf serialization is required for the entire message{"id":"02532011-92da-4199-af7c-1981aabc027c","name":"Device Name","pushed":"1728630032437","origin":1728630032437,// Data Time"readings":{"cpu usage":18,// Property: Property Value"memory usage":36,"data disk usage":32,"system disk usage":15}}Equipment Status Reporting:api/v1/device/1da9ff01-7fdb-4cec-b8b4-dfcaa5768219/state/online{"id":"1da9ff01-7fdb-4cec-b8b4-dfcaa5768219","name":"Demo","pushed":"1728630031164","origin":1728630031164,"readings":{"state":true}}MessageData Format:// Need to perform protobuf serialization on the entire message{"protocol":"mqtt",// payload: needs to use json serialization"payload":{// Unique identifier for the device"id":"02532011-92da-4199-af7c-1981aabc027c",// Device name"name":"opcdademo01",// Data timestamp"pushed":"1723186564338",// Data timestamp"origin":1723186564338,// Point data"readings":{"temperature":25,"pressure":50}}}proto filesyntax="proto3";packagemodels;messageMessage{ stringchannel=1; stringsubtopic=2; stringpublisher=3; stringprotocol=4; bytespayload=5; int64created=6;//Unixtimestampinnanoseconds}Equipment AccessCreate GatewayPrerequisites■Open an AIoT iuap account.Operation Steps■1.Log in to the AIoT iuap.2.In the IoT middleware page, find IoT Basics -> Gateway, and use the Add button to create a gateway.3.You can create a gateway directly based on actual needs.Explanation of each field:ParameterDescriptionNameGateway NameCodeGateway CodeTypeDivided into Cloud Gateway and Edge GatewayInstallation LocationWhen the type is Edge Gateway, the installation location needs to be selected. It is divided into local and remote methods.DescriptionGateway Description. Optional.Create ModelA model is a collection of devices, typically a set of devices defined by the same functional specifications. For example, a model refers to the same model type, and the device is a specific device under that model. Before connecting devices to the AIoT cloud platform, you need to create a model in the AIoT cloud platform. The following describes the specific operations for creating a model.Prerequisites■Open an AIoT iuap account.Operation Steps■Log in to the AIoT iuap.In the IoT middle platform page, find IoT Basics -> Model, and use the Add button to create a device model.You can create device models directly based on actual needs.On the Add Equipment Model tab, fill in the information as prompted on the page, and then click Preservation.Field Description:ParameterDescriptionDevice Model NameName the device model. The device model name must be unique within the account. Supports Chinese, English letters, Japanese, numbers, underscores (_), hyphens (-), at (@), and English parentheses (()), with a length limit of 4 to 30 characters, where one Chinese or Japanese character counts as 2 characters.DomainThe domain to which the device model belongs, including smart manufacturing, smart agriculture, smart cities, energy and chemicals, security, transportation, etc. Optional.Device ManufacturerThe manufacturer of the corresponding model for this device model. Optional.ImageThe image of the corresponding model for this device model. Optional.Configuration Object ModelYou can configure the property of the physical model on the details page of the device model.Field Description:ParameterDescriptionNameThe name of the function being set, which is unique within this object model.Data TypeThe type corresponding to the property.Read/WriteThe permission of the property is one of the three: ReadCalculation AmountThe calculation amount does not participate in collection.TagTag functionDescriptionDescription information of the function.Create Device4.In the IoT middle platform page, find IoT Basics -> Devices, and use the Add button to create a device.5.After setting the device parameters, click the Preservation button to complete the creation.Field Description:ParameterDescriptionDevice NameDevice NameCodeOptional.Select GatewayThe gateway to which this device belongs.Select ChannelThe channel to which this device belongs.Model SourceDivided into none, model, driver.Collection CycleThe interval at which data is collected from the device.Node.js Reporting:C Language:golang：Supported Agreement ListCurrently supports MQTT, OPCDA, OPCUA, ModbusTcp, SiemensPLC (S7 protocol), OmronPLC, MelsecPLC, RDB (relational database), etc. For protocols beyond this range, it is necessary to purchase third-party data acquisition protocol parsing services.NameIntroductionApplicable ScopeMQTTMQTT (MessageQueuing TelemetryTransport) is a lightweight, publish/subscribe-based messaging protocol.The MQTT protocol is widely used in fields that require device-to-device communication, such as smart homes, smart cities, industrial automation, and automotive systems due to its simplicity, efficiency, and reliability.OPCDAOPCDA relies on Windows platform's DCOM technology, allowing different applications to communicate and exchange data within the Windows operating system. OPCDA (OPC DataAccess) defines the specifications for data exchange, including process values, update time, data quality, etc.OPCDA is widely used in scenarios with high real-time requirements, such as industrial control systems, to achieve real-time control and monitoring of process variables. Through OPCDA, devices like valves and pumps can be manipulated, and measurements of temperature, pressure, liquid levels, and other process variables can be taken. Currently, OPCDA has undergone versions 1.0 (1997), 2.0 (2002), and 3.0.OPCUAUA stands for unified architecture. To address the trends of standardization and cross-platform compatibility, and to better promote OPC, the OPC Foundation has introduced a new OPC standard - OPCUA, based on the successful applications of previous OPC standards.OPCUA is widely applicable in industrial domains, including components such as industrial sensors and actuators, control systems, manufacturing execution systems, and enterprise information systems, including IIoT (IndustrialInternetofThings), machine-to-machine communication (M2M), as well as Industry 4.0 and Made in China 2025. These systems aim to exchange information and send commands and controls to industrial processes. OPCUA defines a common foundational model to facilitate this information exchange more conveniently.ModbusTcpModbusTCP (Modbus over TCP/IP) is a communication standard based on the Modbus protocol, enabling data transmission over TCP/IP networks.Due to the flexibility and reliability of the ModbusTCP protocol, it meets various data communication needs in modern industrial environments, especially in scenarios requiring remote access and control. For example, ModbusTCP is used in automation control systems to connect and control various devices, such as PLC (Programmable Logic Controllers), DCS (Distributed Control Systems), sensors, and actuators.SiemensPLC (S7 Protocol)The Siemens S7 protocol is a proprietary communication protocol developed by Siemens for its S7 series PLCs (Programmable Logic Controllers). It is primarily used for data exchange and communication between PC workstations (PG/PC) and PLCs via Ethernet.The S7 protocol is an important component of Siemens S7 series PLC communication, providing a stable and efficient data communication solution for automation and control systems.OmronPLC (FINS Protocol)OmronPLCFINS protocol, short for FactoryInterfaceNetwork Service, is a proprietary communication protocol developed by Omron for its industrial automation products, such as PLCs (Programmable Logic Controllers) and other devices.The FINS protocol is an important component of Omron automation product communication, providing a solid foundation for building industrial automation communication networks. Through the FINS protocol, users can achieve remote monitoring, control, and data exchange with ...
