Skip to content

Improve /parameters endpoint to get information of subindex access capability #204

@roesekoSICKAG

Description

@roesekoSICKAG

CR 84

Hi, I have a question about reading parameter indices, parameter name and parameter sub-indices, sub-parameter names It is not clear, how to detect, if parameter supports subindexes. Is it required to read subindex information for all parameters to detect, if parameter has a subindex access? I would propose to add information about subindexes for read request for index

GET /iolink/v1/devices/sensor34/parameters
Response: 
[
    {
        "index": 10,
        "parameterName": "Vendor_Name""subindexes": [
            {
                "subIndex": 1,
                "subParameterName": "switching_mode"
            },
            {
                "subIndex": 2,
                "subParameterName": "switching_value_on"
            },
            {
                "subIndex": 3,
                "subParameterName": " switching_value_off"
            }
        ]
    },
    {
        "index": 12,
        "parameterName": "Product_Name"
    },
    {
        "index": 13,
        "parameterName": "ProductID"
    }
]

Meeting 10.1.2022: accepted
In the Object parameter List (table 66) an property “subindexAccessSupported” will be added, indicating that subindice access is provided for complex parameters (records or arrays). Additional a GET /parameters Query will be added to provide a full data structure including all subindices proposal as suggested. First proposal : GET /parameters?information=detailed (mandatory or optional) To be defined is the behavior if the query parameter is not implemented (even if IODD is supported) => solution needed regarding backward compatibility

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions