ReadPoint

The readPoint object contains information about the Read Point your application is currently opened on. It contains basic information like the Read Point name, slug id ,uri readerId. It has a readerAgentVersion which enables the user to create different workflows based on the readerAgent installed. It shows a LastModification timestamp to show when the Read Point was edited and a test boolean to indicate if the Read Point is setup on a test workspace. It also contains arrays with the applications and hookIds connected to the Read Point. And a SettingsRoot object containing the Read Point settings. This might be used to give insight on how the reader is set up, or give access to custom settings which can be used to store Read Point specific information.

Properties:

id (string):

• The unique identifier for the Read Point.

name (string):

• The name of the Read Point.

slug (string):

• A human-readable slug for the Read Point, often used for generating URLs or as a reference.

uri (string):

• The URI (Uniform Resource Identifier) associated with the Read Point. This can be a link to the Read Point's web interface or resource location.

readerId (string):

• The identifier of the reader associated with this Read Point.

readerAgentVersion (string):

• The version of the reader agent installed, allowing for custom workflows based on the reader agent's capabilities.

LastModification (string):

• A timestamp indicating when the Read Point was edited. It follows the ISO 8601 date and time format.

test (boolean):

• A boolean flag indicating whether the Read Point is set up in a test workspace. This can be useful for distinguishing between test and production environments.

hookIds (array of strings):

• An array containing unique identifiers (IDs) of hooks connected to this Read Point.

applications (array of objects):

• An array of objects, each representing an application associated with the Read Point. Each object has two properties:
  • applicationId (string): The unique identifier for the application.
  • applicationTagId (string): An optional field with a tag identifier for the application.

settingsRoot (object):

• An object containing the Read Point's settings. It consists of various sub-settings, such as the reader settings, observation filters, GPIO configuration, printer settings, connected peripherals like barcode readers, automation settings to control automations like tunnels and other conveyor systems, logging, and custom settings.

Example code:

{
    "id": "6567f127c892cddcc06d9a5b3",
    "name": "ReadPoint Name",
    "slug": "readpoint-name",
    "uri": "https://nedap-harmony.com/loc/readpoint-name",
    "readerId": "89052bded5a222f0c4430385b5",
    "settingsRoot": {
        "reader": {
            "mode": "Triggered",
            "session": "Session0",
            "target": "Ab",
            "antennae": [
                {
                    "antennaId": 1,
                    "enabled": true
                }
            ],
            "outputPower": 25
        },
        "gpioBehaviour": {
            "defaultGpoState": [
                {
                    "portNumber": 1,
                    "level": true
                }
            ]
        },
        "custom": [
            {
                "key": "customSettings",
                "value": "1234567"
            }
        ]
    },
    "hookIds": [
        "5f43cd28r5692117a091b068",
        "5f4caccfb673184742210f8e"
    ],
    "applications": [
        {
            "applicationId": "64f828a832226b3526f25839",
            "applicationTagId": ""
        },
        {
            "applicationId": "644253bcb26bb51a8e465422",
            "applicationTagId": ""
        }
    ],
    "readerAgentVersion": "0.46.0",
    "test": false,
    "lastModification": "2023-09-06T07:36:51.424Z"
}