Driver Info
Asset links identify themselves towards the gRPC server regsitry via the Driver Info API
API Description
DriverInfoApi
=========================================== The Services Definition
GetVersionInfo
rpc GetVersionInfo(GetVersionInfoRequest) GetVersionInfoResponse
Possible return values - OK
GetConfigSchema
rpc GetConfigSchema(GetConfigSchemaRequest) GetConfigSchemaResponse
Possible return values - OK - FAILED_PRECONDITION - no local configuration available (or accessible)
GetAppIcon
rpc GetAppIcon(GetAppIconRequest) GetAppIconResponse
implementation of this call is optional Possible return values - OK - UNIMPLEMENTED - function not supported - INVALID_ARGUMENT - parameters are wrong - FAILED_PRECONDITION - icon not available
Messages
ConfigSchema {#configschema}
| Field | Type | Description |
|---|---|---|
| uri | string | URI of the schema |
| schema | string | JSON string with configuration schema |
GetAppIconRequest {#getappiconrequest}
================================================================== Get Icon
List of supported image formats by the client e.g. ["svg+xml", "png"] The list is sorted in the order of preferences (most preferred at the beginning). Support of "png" is mandatory by the server and the client, that means it shall always be contained in this list. When the client omits "png" from the list, the server is nervertheless allowed to return "png" because this is mandatory. For all other image formats the server shall only return a format which is contained in the list and fall back to "png" when nothing else matches. The format names are according to image mime-type defined by https://www.iana.org/assignments/media-types/media-types.xhtml#image but without the "image/" prefix because that is obligatory. repeated string supported_image_formats = 1;
GetAppIconResponse {#getappiconresponse}
| Field | Type | Description |
|---|---|---|
| image_format | string | Image format of the returned image. The aspect rate of the image shall be 1:1 that means a square image. Server should select the format with best fit for the client request (best effort, don't scale the image to this size!). The format names are according to image mime-type defined by https://www.iana.org/assignments/media-types/media-types.xhtml#image but without the "image/" prefix because that is obligatory. e.g. "png" or "svg+xml" At the moment the only supported format is "png". We will decide in future if we support more formats and introduce 'supported_image_formats' in the request then. |
| image_data | bytes | Byte array containing the image data |
GetConfigSchemaRequest {#getconfigschemarequest}
================================================================== Config Schema
void
GetConfigSchemaResponse {#getconfigschemaresponse}
| Field | Type | Description |
|---|---|---|
| schemas | repeated ConfigSchema | configuration schema(s) |
GetVersionInfoRequest {#getversioninforequest}
================================================================== Driver Version
void
GetVersionInfoResponse {#getversioninforesponse}
| Field | Type | Description |
|---|---|---|
| version | VersionInfo | version information |
VersionInfo {#versioninfo}
Version Info
| Field | Type | Description |
|---|---|---|
| major | uint32 | Version numbering according 'Semantic Versioning' (see https://semver.org/) Major - increment for incompatible API changes |
| minor | uint32 | Minor - increment for added functionality in a backwards compatible manner |
| patch | uint32 | Patch - increment for backwards compatible bug fixes |
| suffix | string | Suffix - containing Build number and/or pre-release version. According to the version definition of Industrial Edge OR to https://semver.org/ Don't expect the string to strictly follow semver, especially for checking which version is newer!!!!! Can be an empty string. Industrial Edge always uses "-" as the first character which is a violation of semver! Here some examples for Industrial Edge version suffixes: - "" - "-0" - "-1" - "-rc.1" - "-rc.1.alpha.23773115" - "-beta.2.rc.23652691" - "-3.0" |
| vendor_name | string | vendor name, e.g. "Siemens AG" |
| product_name | string | product name, e.g. "SIMATIC S7+ Connector" |
| product_description | string | description of the application, e.g. "Connector for SIMATIC S7-1200 and S7-1500 PLCs using S7+ protocol" |
| docu_url | string | the documentation URL of the driver e.g. the company webpage with a deep link directly the docu |
| feedback_url | string | feedback url for customers, it's different for different products |