Data interoperability has been identified as a technical barrier that prohibits the realisation of the full potential value of IoT data. To help address that problem, in this document data models are defined of entities or things that are commonly used in IoT applications. The definitions of the data entities have been developed through contributions from participating mobile operators and aligned with existing industry work and namespaces where possible, for example, oneM2M in Smart Home, OASC for Smart Cities and schema.org for generic entities.
This resource specifies harmonised data models that have been developed by members of the GSMA IoT Big Data Ecosystem Project. The harmonised data models are expected to evolve over time, potentially new entities will be added and entity definitions changed. Contributions are welcome from the wider developer community to develop and update the data entities.
The harmonised data entities below originate from and are used in the following industry verticals (or IoT Domains):
- Agriculture
- Automotive
- Environment
- Industry
- Smart City
- Smart Home
| Entity Name | Overview | Context Definition | Example Entity |
|---|---|---|---|
| Agri Crop | This entity contains a harmonised description of a generic crop. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Agri Greenhouse | This entity contains a harmonised description of the conditions recorded within a generic greenhouse, a type of AgriParcel. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Agri Parcel | This entity contains a harmonised description of a generic parcel of land. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Agri Parcel Operation | This entity contains a harmonised description of a generic operations performed on a parcel of land. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Agri Parcel Record | This entity contains a harmonised description of the conditions recorded on a generic parcel of land. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Agri Pest | This entity contains a harmonised description of an agricultural pest. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Agri Product Type | This entity contains a harmonised description of a generic agricultural product type. This entity is primarily associated with the agricultural vertical and related IoT applications. The AgriProductType includes a hierarchical structure that allows product types to be grouped in a flexible way. Specification. | Context example. | Entity example. |
| Agri Soil | This entity contains a harmonised description of soil. This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Air Quality Observed | This entity contains a harmonised description of the air quality observed at a particular location and time. This entity is primarily associated with the vertical segment of the environment and may also be used in smart homes, smart cities, agriculture, industry and related IoT applications. Specification. | Context example. | Entity example. |
| Building | This entity contains a harmonised description of a building. This entity is associated with the vertical segments of smart homes, smart cities, industry and related IoT applications. Specification. | Context example. | Entity example. |
| Building Operation | This entity contains a harmonised description of a generic operation (related to smart buildings) applied to the referenced building. The building operation contains dynamic data reported by, or associated with a building or operations applicable to the building. This entity is associated with the vertical segments of smart homes, smart cities, industry and related IoT applications. Specification. | Context example. | Entity example. |
| Building Type | This entity contains a harmonised description of a generic building type. This entity is associated with the vertical segments of smart home, smart cities, industry and related IoT applications. The building type includes a hierarchical structure that allows building types to be grouped in a flexible way. Specification. | Context example. | Entity example. |
| Device | This entity contains a harmonised description of a generic device. This entity provides an essentially static description of a generic device and is therefore applicable to all IoT segments and related IoT applications. Specification. | Context example. | Entity example. |
| Device Model | This entity contains a harmonised description of a generic device model and is therefore applicable to all IoT segments and related IoT applications. The Device Model includes an optional hierarchical structure that allows device types to be grouped in a flexible way. Specification. | Context example. | Entity example. |
| Device Operation | This entity contains a harmonised description of a generic device operation entity. The device operation entity contains dynamic data reported by a device and is therefore applicable to all IoT segments and related IoT applications. Specification. | Context example. | Entity example. |
| Environment Observed | This entity contains a harmonised description of the environmental conditions observed at a particular location and time. This entity is primarily associated with the vertical segment of the environment and agriculture but may also be used in smart home, smart cities, industry and related IoT applications. Specification. | Context example. | Entity example. |
| Fleet Vehicle | This entity contains a harmonised description of a generic fleet vehicle such as a delivery vehicle, an ambulance or a postal vehicle. This entity is primarily associated with the vertical segment of the transport and logistics but may also be used many other related IoT applications. Specification. | Context example. | Entity example. |
| Fleet Vehicle Operation | This entity contains a harmonised description of a generic fleet vehicle operation such as a delivery, or a postal collection. This entity is primarily associated with the vertical segment of the transport and logistics but may also be used many other related IoT applications. Specification. | Context example. | Entity example. |
| Fleet Vehicle Status | This entity contains a harmonised description of the status of a generic fleet vehicle. This entity is primarily associated with the vertical segment of the transport and logistics but may also be used many other related IoT applications. Specification. | Context example. | Entity example. |
| Machine | This entity contains a harmonised description of an industrial machine for example for use in CAM (Computer Aided Manufacturing). This entity provides an essentially static description of a generic automation machine. This entity is primarily associated with the industry segment in the automated manufacturing industry, including CNC (Computer Numerical Control) machines, 3D printers and all kinds of industrial robots. Specification. | Context example. | Entity example. |
| Machine Model | This entity contains a harmonised description of a generic machine model. This entity is primarily associated with the industry segment and related IoT applications. The machineModel includes a hierarchical structure that allows machine models to be grouped in a flexible way. Specification. | Context example. | Entity example. |
| Machine Operation | This entity contains a harmonised description of a generic machine operation. This entity is primarily associated with the industry segment and related IoT applications. Each MachineOperation instance will be related to a specific Machine instance. Specification. | Context example. | Entity example. |
| Market Price Forecast | This entity contains a harmonised description of a generic commodity, crop or product price forecast that varies over time (a spot price forecast). This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Market Price Observed | This entity contains a harmonised description of a generic commodity, crop or product price that varies over time (a spot price). This entity is primarily associated with the agricultural vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Point of Interest | This entity contains a harmonised geographic description of a Point of Interest. This entity is used in applications that use spatial data and is applicable to Automotive, Environment, Industry and Smart City vertical segments and related IoT applications. Specification. | Context example. | Entity example. |
| Product | This entity contains a harmonised description of a generic product. This entity is primarily associated with products and supply chains. It is based on the GS1 standard available at http://gs1.org/voc/Product Specification. | Context example. | Entity example. |
| Product Record | This entity contains a harmonised description of the conditions recorded as a product (generally a physical instance of a product) moves through the supply chain. This entity is primarily associated with the retail supply vertical and related IoT applications. Specification. | Context example. | Entity example. |
| Product Type | This entity contains a harmonised description of a generic product type. This entity is primarily associated with the product supply chain verticals and related IoT applications. The ProductType includes a hierarchical structure that allows product types to be grouped in a flexible way. Specification. | Context example. | Entity example. |
| Recogniser Input | This entity contains a generic model for an input to an AI/ Machine Learning based image/audio recogniser Specification. | Context example. | Entity example. |
| Recogniser Result | This entity contains a generic model for the resulting outputs from an AI/ Machine Learning based image/audio recogniser where multiple features are processed. Specification. | Context example. | Entity example. |
| Recogniser Simple Result | This entity contains a generic model for a simple result output from an AI/ Machine Learning based image/audio recogniser Specification. | Context example. | Entity example. |
| Road | This entity contains a harmonised geographic and contextual description of a Road. Roads are made up of one or more RoadSegment entities. This entity is primarily associated with the Automotive and Smart City vertical segments and related IoT applications. Specification. | Context example. | Entity example. |
| Road Segment | This entity contains a harmonised geographic and contextual description of a RoadSegment. A collection of RoadSegments are used to describe a Road. This entity is primarily associated with the Automotive and Smart City vertical segments and related IoT applications. Specification. | Context example. | Entity example. |
| Smart Meter | This entity contains a harmonised description of a Smart Meter, generally applicable for Smart Homes, Industry, Cities and Agriculture. It is designed to be a base for smart meter observations Specification. | Context example. | Entity example. |
| Smart Meter Observed | This entity contains a harmonised description of a Smart Meter Observation, generally applicable for Smart Homes, Industry, Cities and Agriculture. Specification. | Context example. | Entity example. |
| Subscriber | This entity contains a harmonised description of a subscriber to a service. This entity is primarily associated with the Smart Home/ Smart Buildings vertical segments and related IoT applications. Specification. | Context example. | Entity example. |
| Subscription Service | This entity contains a harmonised description of a subscription service. This entity is primarily associated with the Smart Home/ Smart Building vertical segments and related IoT applications. Specification. | Context example. | Entity example. |
| UAV | This entity contains a harmonised description of a specific Unmanned Aerial Vehicle (UAV). This entity is primarily associated with UAV command and control and related UAV transport applications. Specification. | Context example. | Entity example. |
| UAV ADSB | This entity contains a harmonised description of a generic UAV Automatic Dependent Surveillance–Broadcast. This entity is primarily associated with the control and management of Unmanned Aerial Vehicles. Each UAVADSB instance will be related to a specific UAV instance. Specification. | Context example. | Entity example. |
| UAV Event | The UAVEvent records the incursion of a specific UAV into or near protected airspace or locations. It also records the control measure taken. This entity is primarily associated with UAV command and control and related UAV transport applications. Specification. | Context example. | Entity example. |
| UAV Model | This entity contains a harmonised description of a generic Unmanned Ariel Vehicle (UAV) model and is applicable to UAV command and control and related UAV transport applications. Specification. | Context example. | Entity example. |
| UAV State Vector | This entity contains a harmonised description of a generic UAV State Vector, which is an Interpretation and aggregation of Automatic Dependent Surveillance–Broadcast messages. This entity is primarily associated with the control and management of Unmanned Aerial Vehicles. Each UAVStateVector instance is related to a specific UAV instance. Specification. | Context example. | Entity example. |
| UAV TMS | This entity contains a harmonised description of a specific Unmanned Aerial Vehicle (UAV) Traffic Management Software Application that is designed to listen to and monitor the information transmitted by UAV’s, typically this software application would be operated at a ground station. This entity is primarily associated with UAV command and control applications. Specification. | Context example. | Entity example. |
| UAV UTM Flight Message | This entity contains a harmonised description of a generic UAV UTM Flight Message, which contains a Global UTM Association protocol message. This entity is primarily associated with the control and management of Unmanned Aerial Vehicles. Each UAVUTMFlightMessage instance is related to a specific UAV instance. Specification. | Context example. | Entity example. |
| UAV UTM Flight Message Agent | This entity contains a harmonised description of a generic UAV UTM Flight Message Agent that is designed to subscribe to the Global UTM Association protocol message according to a specific UAV entity. This entity supports the functionality of a service provider to confirm the validity of UTM Flight Message generated by UTM Flight Message Entity. The service provider can include their own Flight Control Policy to the original UTM Flight Message and forward this to a UAVTMS entity. Specification. | Context example. | Entity example. |
| Vehicle | This entity contains a harmonised description of a Vehicle. This entity is primarily associated with the Automotive vertical segment but might also be relevant to Industry, Smart City and Agriculture related IoT applications. Where practicable https://schema.org/Vehicle naming conventions have been adopted. Specification. | Context example. | Entity example. |
| Vehicle Fault | This entity contains a harmonised description of a Vehicle Fault. This entity is primarily associated with the Automotive vertical segment but might also be relevant to Industry, Smart City, Agriculture and related IoT applications. Specification. | Context example. | Entity example. |
| Vehicle Type | This entity contains a harmonised description of a vehicleType it forms part of the description of a Vehicle. This entity is primarily associated with the Automotive vertical segment but might also be relevant to Industry, Smart City and Agriculture related IoT applications. Where practicable https://schema.org/Vehicle naming conventions have been adopted. Specification. | Context example. | Entity example. |
| Water Quality Observed | This entity contains a harmonised description of the water quality at a particular location and time. This entity is primarily associated with the vertical segments of agricultural and environment and related IoT applications. Specification. | Context example. | Entity example. |
| Weather Forecast | This entity contains a harmonised description of a Weather Forecast. This entity is primarily associated with the vertical segments of the environment and agriculture but is applicable to many different applications. Specification. | Context example. | Entity example. |
| Weather Observed | This entity contains a harmonised description of the weather at a particular location and time. This entity is primarily associated with the vertical segments of the environment and agriculture but is applicable to many different applications. Specification. | Context example. | Entity example. |