CN110830455A

CN110830455A - Equipment model description method

Info

Publication number: CN110830455A
Application number: CN201911006276.XA
Authority: CN
Inventors: 姚明远; 欧涛涛; 杨智龙; 张金平; 杨刘阳; 周扬; 胡铁
Original assignee: Wuhan Ligong Guangke Co Ltd
Current assignee: Wuhan Ligong Guangke Co Ltd
Priority date: 2019-10-22
Filing date: 2019-10-22
Publication date: 2020-02-21
Anticipated expiration: 2039-10-22
Also published as: CN110830455B

Abstract

The invention provides an equipment model description method, and defines a general equipment model framework, the equipment model framework comprises states, configurations, commands and events, the equipment is defined by using the equipment model description method recorded by the embodiment, and an upper computer only needs to read the equipment model to know which commands and events are supported by the equipment, which states, configurations and formats are available, and can be directly called; after the equipment is upgraded, only the equipment model needs to be read again, and the code of the upper computer does not need to be modified; the equipment developer only needs to fill the equipment model frame according to the equipment model frame, and does not need to modify the communication protocol, so that the configuration definition items of the equipment model are simplified; for the device with limited memory, only the ID of the device model is replied, and the device with the device model is not replied, the upper computer only needs to import the description file of the device model, and the description of the device model can be inquired according to the ID.

Description

Equipment model description method

Technical Field

The invention relates to the field of Internet of things equipment communication, in particular to an equipment model description method.

Background

Most of existing internet-of-things equipment communication is that a communication protocol is defined firstly, a cloud platform or an upper computer can operate the equipment after the communication protocol is known, the cloud platform or the upper computer needs to be modified correspondingly after the newly added state and configuration of the equipment are upgraded, and corresponding equipment can be managed only by leading in an equipment model even if the internet-of-things platform with the equipment model concept exists. The existing equipment model needs to be defined by equipment developers according to equipment, when the equipment is replaced or upgraded, the previously defined equipment model cannot be suitable for the transformed equipment, and the equipment can be described only by filling a large number of configuration definition items by the equipment developers during each upgrade or replacement, so that the problem of complex definition items exists. Therefore, in order to solve the above problems, the present invention provides an equipment model description method, which defines a general equipment model framework and predefines some common commands, so that an equipment developer can implement complete equipment description only by filling in the equipment state and configuration, and does not need to define the equipment model many times.

Disclosure of Invention

In view of this, the present invention provides an equipment model description method, which defines a general equipment model framework, and an equipment developer can implement complete equipment description only by filling in an equipment state and configuration, without defining an equipment model many times.

The technical scheme of the invention is realized as follows: the invention provides an equipment model description method, which comprises the following steps:

s1, defining all functions of the equipment by using one equipment function model;

s2, the upper computer sends downlink data of the query equipment model to the lower computer;

s3, the lower computer replies the uplink data with the equipment model information to the upper computer;

and S4, the upper computer analyzes the uplink data.

On the basis of the above technical solution, preferably, the device function model in S1 includes a downlink data model, an uplink data model, a predefined field model, a custom object list, and a custom enumeration list;

the predefined field model includes: the method comprises the following steps of (1) a device state model, a device configuration model, a command list and an event list;

the downlink data model is used for describing downlink data objects, the uplink data model is used for describing uplink data objects, the equipment state model and the equipment configuration model are used for describing equipment state objects and equipment configuration objects, and the models belong to object models;

the command list and the event list belong to an enumeration type, and the enumeration type is defined by an enumeration model;

the user-defined object list is an array of which the elements are objects, and the objects are defined through an object model;

the custom enumeration list is an array whose elements are enumerated, and enumeration is defined by an enumeration type.

Further preferably, the downlink data model includes: command, configuration, and status;

the command is an enumeration type, and the enumeration type is defined through an enumeration model;

the configuration and state are object models, and the object models are defined through the object models.

Further preferably, the uplink data model includes: device number, device model ID, device model, command, event, status, and configuration.

Further preferably, the command includes: querying the device model, read status, write status, read configuration, write configuration, subscribe to events, and unsubscribe.

Further preferably, the object model comprises a list of object fields;

the object field list is used for describing which fields the object comprises, the object field list is an array, array elements are fields, and the fields are defined by a field model.

Further preferably, the field model includes a field ID, a field name, a field number, and a field type ID.

Further preferably, the enumeration model comprises a list of enumeration terms;

the enumeration item list is used for describing which enumeration items are included in the enumeration, the enumeration item list is an array, array elements are enumeration items, and the enumeration items are defined through an enumeration item model.

Further preferably, the enumerated term model includes enumerated term names and values.

Compared with the prior art, the equipment model description method has the following beneficial effects:

(1) defining a universal equipment model framework, wherein the equipment model framework comprises states, configurations, commands and events, and defining equipment by using the equipment model description method recorded by the invention, and an upper computer only needs to read the equipment model to know which commands and events are supported by the equipment, which states, configurations and formats are available, and can be directly called;

(2) after the equipment is upgraded, only the equipment model needs to be read again, and the code of the upper computer does not need to be modified; the equipment developer only needs to fill the equipment model frame according to the equipment model frame, and does not need to modify the communication protocol, so that the configuration definition items of the equipment model are simplified;

(3) for the device with limited memory, only the ID of the device model is replied, and the device with the device model is not replied, the upper computer only needs to import the description file of the device model, and the description of the device model can be inquired according to the ID.

(4) The device can be in butt joint with the upper computer only by realizing predefined read-write configuration and read-write state commands, and a user-defined command is not needed.

Drawings

In order to more clearly illustrate the embodiments of the present invention or the technical solutions in the prior art, the drawings used in the description of the embodiments or the prior art will be briefly described below, it is obvious that the drawings in the following description are only some embodiments of the present invention, and for those skilled in the art, other drawings can be obtained according to the drawings without creative efforts.

FIG. 1 is a flow chart of a method for describing an equipment model according to the present invention.

Detailed Description

The technical solutions in the embodiments of the present invention will be clearly and completely described below with reference to the embodiments of the present invention, and it is obvious that the described embodiments are only a part of the embodiments of the present invention, and not all of the embodiments. All other embodiments, which can be obtained by a person skilled in the art without any inventive step based on the embodiments of the present invention, are within the scope of the present invention.

Example 1

The device model is a tree-like data structure that describes the functions of the device, the formats in which data is received and sent, what states, configuration parameters and formats the device has, and what commands and events the device supports. Wherein, the state, configuration and event of the equipment are customized by the specific equipment. The device has several predefined commands: read-write configuration, read-write state, read device model, subscribe event, unsubscribe event, upgrade, in addition to which the device can customize the command. Because the existing device model is too abstract, a device developer needs to fill in a large number of configuration definition items to describe the device, and the problem of complex definition items exists. Accordingly, as shown in fig. 1, the present invention provides an apparatus model description method, which includes:

and S4, the upper computer analyzes the uplink data.

The device function model is a tree-like data structure for describing the functions of the device, the formats of the received data and the sent data, which states, configuration parameters and formats are available for the device, and which commands and events are supported by the device. The state, configuration and event of the equipment are customized by the specific equipment, and the equipment has the following predefined commands: read-write configuration, read-write state, read device model, subscribe event, unsubscribe event, upgrade, in addition to which the device can customize the command. The device function model of this embodiment is a general template.

The upper computer comprises a cloud platform and other equipment in the Internet of things network. The data sent to the equipment by the upper computer is called downlink data, the data sent to the upper computer by the equipment is called uplink data, the downlink data is a command, the uplink data is divided into two types, one type is a reply to the command, and the other type is an event actively reported.

The beneficial effect of this embodiment does: a universal equipment model framework is defined, when an equipment developer defines an equipment model, the equipment model framework is only required to be filled according to the universal equipment model framework of the embodiment, modification operation on a communication protocol is not required, configuration definition items of the equipment model are simplified, and after the equipment is upgraded, the equipment model is only required to be read again, and codes of an upper computer are not required to be modified.

Example 2

On the basis of embodiment 1, this embodiment provides a specific structure of the device function model. In this embodiment, the device function model includes a downlink data model, an uplink data model, a predefined field model, a custom object list, and a custom enumeration list; wherein the predefined field model comprises: a device state model, a device configuration model, a command list, and an event list. The device state model and the device configuration model are used for describing a device state object and a device configuration object, and the models belong to object models; the command list and the event list belong to an enumeration type, and the enumeration type is defined by an enumeration model; the user-defined object list is an array with elements as objects, and the objects are defined through an object model; the custom enumeration list is an array whose elements are enumerated, the enumeration being defined by an enumeration type.

In this embodiment, "DeviceModel" is used to represent "device function model", "ObjectModel" is used to represent "object model", "FieldModel" is used to represent "field model", "enummermodel" is used to represent "enumeration model", and "enumtemotmodel" is used to represent "enumeration item model".

Further preferably, the device function model further includes selectable items such as a device model ID, a device model name, and a device model description, and the field types of the device model ID, the device model name, and the device model description are not limited and may be any type.

Specifically, the device function model is defined as follows:

field ID	Name of field	Field type and description
			id	Device model ID	Character string
name	Device model name	Character string
			description	Device model description	Character string
downData	Number of lower rowsAccording to a model	Downdata object type
			upData	Uplink data model	Updata object type
status	Device state model	Status object type
			config	Device configuration model	Config object type
command	Command list	Command enumeration type
			event	Event list	Event enumeration type
objects	Custom object list	Custom object array
			enums	Custom enumeration lists	Custom enumeration array

The downlink data model is used for describing downlink data objects; the command is an enumeration type, and the enumeration type is defined through an enumeration model; the configuration and state are object models, and the object models are defined through the object models. Further preferably, the downlink data further includes an ID list and an upgrade package. The command is an enumeration type, the command is defined by an enumeration model, the configuration and the state are object models, the field types of the ID list and the upgrade package are not limited by the definition of the object models and can be any type, in this embodiment, the field type of the ID list is preferably a uint8 array, and is self-defined by the command, and different command meanings are different. Specifically, the downlink data includes the following predefined fields:

field numbering	Field ID	Name of field	Field type and description
				0	cmd	Command	Command enumeration
1	ids	ID list	The agent 8 array is defined by commands, and different commands have different meanings
				2	config	Configuration of	Config object type
3	status	Status of state	Status object type
				4	fwPkt	Upgrade package

The uplink data model is used for describing an uplink data object, and the uplink data comprises: device number, device model ID, device model, command, event, status, and configuration. Further preferably, the uplink data further includes: command result code, upgrade status, and upgrade package. The field types of the equipment number and the equipment model ID are not limited and can be any types; the equipment model ID is an equipment model description file, and the format of the equipment model description file is json format. Specifically, the uplink data includes the following predefined fields:

the device can add custom fields, the did fields must be filled, the cmd must be filled if the command replies, the event must be filled if the event replies, other fields are optional, and the specific fields are specified by the command or the event.

The downlink data and the uplink data both include a command field, and in this embodiment, the command includes: querying the device model, read status, write status, read configuration, write configuration, subscribe to events, and unsubscribe. Specifically, the command field includes the following predefined enumerated items:

enumerating item values	Enumerating item ID	Enumerating item names	Description of the invention
				0	Test	Testing
1	List	Querying device models	Returning the device model or device model ID
				2	ReadStatu	Read status
3	WriteStatus	Writing state
				4	ReadConfig	Read configuration
5	WriteConfig	Write configuration
				6	Subscribe	Subscribing to events
7	Unsubscribe	Unsubscribing
				8	Upgrade	Upgrading

Wherein the device can add custom commands. The most critical command in the command field is to query the device model, i.e. List, the device can directly return the complete device model, and the upper computer knows which commands, events, states, configurations and formats the device supports after receiving the device model. Fields included in the downlink data in S2 and the uplink data in S3 in embodiment 1 are the same as those of the downlink data and the uplink data described in this embodiment, and therefore, description thereof will not be repeated.

Because the equipment state model and the equipment configuration model in the equipment function model both belong to the object model, the self-defined object list is an array with elements which are all objects, and the objects are defined through the object model. In this embodiment, the object model includes: and the object field list is an array with elements being fields, and the fields are defined by field models. The object model also includes options such as object ID, object name, and object description. The field types of the object ID, the object name, and the object description are not limited, and may be any type. Specifically, the object model is defined as follows:

field ID	Name of field	Field type and description
			id	Object ID	Character string
name	Object name	Character string
			description	Object description	Character string
fields	Object field list	FieldModel array

Since the object field list is used to describe which fields the object includes, the object field list is an array, the array elements are fields, and the fields are defined by the field model. Therefore, in the present embodiment, the field model includes a field model including a field ID, a field name, a field number, and a field type ID. Further preferably, the field type further includes: field descriptions, etc. The field type of the field description, the field number, and the field type ID is not limited, and may be any type, in this embodiment, the field type of the field ID, the field name, and the field description is preferably a character string, the field type of the field number is preferably a uint8, the field type of the field type ID is preferably a character string, and the basic data type ID, the object ID, or the enumeration type ID is filled. Specifically, the field types are defined as follows:

the self-defined enumeration list in the device function model is an array with enumerated elements, enumeration is defined by an enumeration type, the command list and the event list belong to the enumeration type, and the enumeration type is defined by the enumeration model. Therefore, in this embodiment, the enumeration model includes an enumeration item list, where the enumeration item list is used to describe which enumeration items are included in the enumeration, the enumeration item list is an array, the array element is an enumeration item, and the enumeration item is defined by the enumeration item model. . Further preferably, the enumeration model further includes options such as an enumeration ID, an enumeration name, and an enumeration description. The field types of the enumeration ID, the enumeration name, and the enumeration description are not limited, and may be any type, and in this embodiment, the enumeration ID, the enumeration name, and the enumeration description are all character strings.

Specifically, the enumeration model is defined as follows:

field ID	Name of field	Field type and description
			id	Enumerating IDs	Character string
name	Enumerating names	Character string
			description	Enumerating descriptions	Character string
values	Enumerating lists of items	EnumItemModel array

Further preferably, the enumerated term model includes enumerated term names and values. The enumerating term model further comprises: enumeration ID, enumeration description, and other preferences. The field types of the enumeration item ID, the enumeration item name, the enumeration item description, and the enumeration item value are not limited, and may be any type, in this embodiment, the field types of the enumeration item ID, the enumeration item name, and the enumeration item description are preferably character strings, and the field type of the enumeration item value is preferably uint 8. Specifically, the enumerated item model is defined as follows:

field ID	Name of field	Field type and description
			id	Enumerating item ID	Character string
name	Enumerating item names	Character string
			description	Enumerating item descriptions	Character string
value	Enumerating item values	uint8

The beneficial effect of this embodiment is: a universal equipment model framework is defined, the equipment model framework comprises states, configurations, commands and events, new and old equipment is defined by using the equipment model description method recorded in the embodiment, after the new and old equipment is updated to a new state or configuration, the equipment model is only needed to be read, the upper computer can know which commands, events, states, configurations and formats supported by the equipment after receiving the equipment model, the upper computer can directly call the commands, the events, the states, the configurations and the formats of the events, and an equipment developer only needs to fill the equipment model framework according to the equipment model framework without modifying a communication protocol, so that configuration definition items of the equipment model are simplified.

Example 3

On the basis of embodiment 2, this embodiment provides an embodiment of querying a device model. In this embodiment, the lower computer is assumed to be a water pressure gauge.

When the upper computer needs to inquire the equipment model of the lower computer, the upper computer sends down data with the following values:

the lower computer recovers one uplink data of the upper computer, and the values are as follows:

and the upper computer receives the uplink data and analyzes the equipment model. The upstream data includes a status field, a config field, a command field, and an event field. Because the model is longer, the upper computer analyzes the equipment model, and the model is longer, which is explained in sequence according to the fields as follows:

first, a status field is parsed, which is an ObjectModel structure, and values are as follows:

field ID	Name of field	Field type and description	Value taking
				id	Object ID	Character string	“Status”
name	Object name	Character string	"device status"
				fields	Object field list	FieldModel array	See the following Table

An example FieldModel array value is as follows:

id	name	fid	type
				waterPressure	water pressure	0	float
batteryLevel	Electric quantity of battery	1	uint8

By analyzing the above, the upper computer knows that the equipment has two states, one is water pressure and float type, and the other is battery power and fluid 8 type.

Next, parsing the config field, where the config field is an ObjectModel structure, and values are as follows:

field ID	Name of field	Field type and description	Value taking
				id	Object ID	Character string	“Config”
name	Object name	Character string	"Equipment configuration"
				fields	Object field list	FieldModel array	See the following Table

An example FieldModel array value is as follows:

id	name	fid	type
				versionName	version number	0	string
detectionPeriod	Detection period	1	uint16
				uploadPeriod	Reporting period	2	uint16

And analyzing the configuration information, wherein the upper computer knows that the equipment has three configurations, namely a version number, a string type, a detection period, a uint16 type, a reporting period and a uint16 type.

And then analyzing a command field, wherein the command field is an EnumModel structure, and the value example is as follows:

field ID	Name of field	Field type and description	Value taking
				id	Enumerating IDs	Character string	“Command”
name	Enumerating names	Character string	"Command"
				values	Enumerating lists of items	EnumItemModel array	See the following Table

An example EnumItemModel array value is as follows:

id	name	value
			Test	testing	0
List	Querying device models	1
			ReadStatus	Read status	2
WriteStatus	Writing state	3
			ReadConfig	Read configuration	4
WriteConfig	Write configuration	5
			Subscribe	Subscribing to events	6
Unsubscribe	Unsubscribing	7
			Upgrade	Upgrading	8
ZeroCalib	Zero point calibration	9

At this point, the upper computer knows that the equipment has 9 predefined commands and also has a self-defined command of zero point calibration.

And finally, analyzing an event field, wherein the event field is an EnumModel structure, and the value example is as follows:

field ID	Name of field	Field type and description	Value taking
				id	Enumerating IDs	Character string	“Event”
name	Enumerating names	Character string	"event
				values	Enumerating lists of items	EnumItemModel array	See the following Table

An example EnumItemModel array value is as follows:

id	name	value
			Online	equipment on-line	0
Overpressure	Hydraulic overpressure	1

And analyzing the data, wherein the upper computer knows that the equipment has two events, wherein Online represents the Online of the equipment, and Overpressure represents the water pressure Overpressure.

The beneficial effect of this embodiment does: the device model is defined according to the general device model framework described in embodiment 1, and the uplink data and the downlink data are configured, and in the downlink data, it is only necessary to query the device model to know which states and configurations exist in the device, which events can be reported, which commands can be issued, and upper computer software does not need to be re-developed.

In addition, for the device with limited memory, which only replies the device model ID but not the device model, the upper computer only needs to import the device model description in json format, and after the model ID is queried, the device model description can be queried according to the ID.

Example 4

On the basis of embodiment 1, this embodiment provides a method for reading a device status. The method comprises the following specific steps:

the upper computer sends down data to the lower computer, and the values of the down data are as follows:

field numbering	Field ID	Name of field	Value taking
				0	cmd	Command	ReadStatus

The lower computer replies an uplink data to the upper computer, and the values are as follows:

the upper computer receives the uplink data and analyzes the uplink data to know that the water pressure is 1.2 and the battery power is 99.

The beneficial effect of this embodiment does: the device can be in butt joint with the upper computer only by realizing predefined read-write configuration and read-write state commands, and a user-defined command is not needed.

Example 5

On the basis of embodiment 1, the present embodiment provides a method of writing a device state. Taking the example of changing the reporting period of the lower computer to 30 seconds, the specific implementation process is as follows:

the upper computer sends downlink data to the lower computer, and the values are as follows:

the lower computer restores uplink data after the configuration is modified, and the values are as follows:

field numbering	Field ID	Name of field	Value taking
				0	did	Device numbering	“2018080008”
3	cmd	Command	WriteConfig
				4	code	Command result code	0 (indicating success)

And the upper computer receives the uplink data and analyzes the uplink data, and the command result codes show that the write configuration is successful.

The above description is only for the purpose of illustrating the preferred embodiments of the present invention and is not to be construed as limiting the invention, and any modifications, equivalents, improvements and the like that fall within the spirit and principle of the present invention are intended to be included therein.

Claims

1. An equipment model description method, characterized by: the method comprises the following steps:

and S4, the upper computer analyzes the uplink data.

2. A method for describing an equipment model according to claim 1, characterized in that: the device function model in the S1 comprises a downlink data model, an uplink data model, a predefined field model, a custom object list and a custom enumeration list;

the command list and the event list belong to enumeration types, and the enumeration types are defined through an enumeration model;

the user-defined object list is an array with elements being objects, and the objects are defined through an object model;

the self-defined enumeration list is an array with enumerated elements, and enumeration is defined by an enumeration type.

3. A device model description method according to claim 2, characterized in that: the downlink data model comprises: command, configuration, and status;

the command is an enumeration type, and the enumeration type is defined by an enumeration model;

the configuration and state are object models, and the object models are defined by the object models.

4. A device model description method according to claim 2, characterized in that: the uplink data model includes: device number, device model ID, device model, command, event, status, and configuration.

5. An apparatus model description method according to claim 3 or 4, characterized in that: the command includes: querying the device model, read status, write status, read configuration, write configuration, subscribe to events, and unsubscribe.

6. A device model description method according to claim 3, characterized in that: the object model comprises a list of object fields;

the object field list is used for describing which fields the object comprises, the object field list is an array, array elements are fields, and the fields are defined by field models.

7. A device model description method according to claim 6, characterized in that: the field model includes a field ID, a field name, a field number, and a field type ID.

8. A device model description method according to claim 3, characterized in that: the enumeration model comprises a list of enumeration terms;

9. A device model description method according to claim 8, characterized in that: the enumerated item model includes an enumerated item name and a value.