Skip to main content

Gateway General Documentation

The Shifu project's gateway is a multi-protocol bridge that supports various protocols such as LwM2M. It provides a unified interaction interface for different IoT devices and systems, simplifying protocol conversion and integration.

Overview​

Shifu Gateway obtains all device information from deviceShifu. It registers devices with the server and updates device information. Shifu Gateway interacts with the server to handle server requests, providing a universal solution for IoT ecosystems. This enables devices using different protocols to be managed and controlled through an integrated gateway, thereby reducing development complexity and facilitating integration with cloud services and other applications.

The gateway component enables devices to adapt to a unified protocol and processes requests from the server. It facilitates data extraction from devices to the server and supports both data publishing and pushing from the cloud to devices.

Key Features​

  • Device Information Transmission: Obtains comprehensive device information from deviceShifu while managing device registration with the server, and continuously maintains and updates device status and configurations throughout the system lifecycle.

  • Server Integration: Implements bidirectional communication with the server, efficiently processes incoming server requests, and manages device responses and data transmission in coordination with deviceShifu. Support for Read, Write and Execute requests.

  • Data Flow Control: Orchestrates comprehensive data management by processing data extracted from various protocol devices, supporting cloud-to-device data publishing, enabling device-to-cloud data pushing, and managing cross-system data routing and transformation.

  • IoT Ecosystem Integration: Delivers a universal connectivity solution that reduces system integration complexity while enabling seamless cloud service integration and facilitating multi-device management across diverse IoT environments.

Typical Use Case​

To support telemetry services for pushing data from devices to data servers, extracting data from devices, or publishing data from the cloud to devices, we need a gateway that enables deviceShifu to adapt to the server's protocol, process requests from the server, and push data to the cloud. Below is a typical use case demonstrating how Shifu Gateway implements these requirements:

  1. Start the client (Shifu Gateway) and obtain all device information from deviceShifu.
  2. Register the device with the server and update the device information.
  3. Handle requests from the server.
  4. If the server enables the Observe feature, notify the server when data changes or a timeout occurs.
  5. Handle read or write requests by calling deviceShifu to get or set the data.
  6. Before shutting down, deregister from the server and stop the client.
  7. If the server disconnects, the gateway will attempt to reconnect and re-register.
  8. If a deviceShifu instruction times out, the gateway will return an error message to the server.

Advantages​

  • Developer-Friendly: Developers can use familiar tools and frameworks (HTTP, MQTT, LwM2M) to interact with IoT devices, reducing development complexity.
  • Flexible Integration: The gateway can be easily integrated into existing IoT ecosystems, supporting interoperability with multiple systems and protocols.
  • Unified Management: By supporting multiple protocols, the gateway provides unified management for different devices and systems, enhancing system scalability.