Skip to content

Light Tag (Android Only)

The Light Tag is a pick-by-light system from NIMMSTA. Each of the Light Tags store their location information on device and can be triggered using the location information. We call the process of defining the location information "Attach". If you reset the location, we call it "Detach". The Light Tag SDK is available for Android only.

Illuminate Light Tags (setDesiredLightTags)

To illuminate a light tag, you need to provide the locations of Light Tags being illuminated and also the desired LED Mode. The SDK in the background will make sure to illuminate the Light Tag as long it is in range and also reilluminate it if it goes out of range and comes back in range. There can be a maximum of 5 Light Tags illuminated at the same time. The Light Tags will be illuminated until a new request is received. To turn it off, send a request with an empty deviceList.

  • deviceList: (string[]) array of strings representing the locations. Maximum 5 locations can be provided.
  • ledMode: (object): LED Mode dictionary
  • color: (string) Name of color (RED, GREEN, BLUE, YELLOW, PURPLE, TURQUOISE, WHITE, ORANGE, VIOLET, FORESTGREEN, MAGENTA, LIME, PINK, EMERGENCY, OFF, RANDOM, AUTOMATIC)
  • intensity: (int) Intensity of the light (0-100)
  • pattern: (string) Name of the pattern (DOUBLE, TRIPLE, BLINK, PULSE, OFF)
{
    "type": "GENERAL_REQUEST",
    "id": 0,
    "action": {
        "name": "SetDesiredLightTags",
        "data": {
            "deviceList": [
              "03.01.08.01",
              "MY-LAGERPLATZ"
            ],
            "ledMode": {
              "color": "RANDOM",
              "intensity": 100,
              "pattern": "TRIPLE"
            }
        }
    }
}

Attach Location (attachLocation)

This action sets the location of a Light Tag. The location is stored on the device and can be used to trigger the Light Tag.

  • deviceAddress: (string) MAC address of the device. Can be scanned from the QR Code on the Light Tag
  • location: (string) Name of the desired location
{
    "type": "GENERAL_REQUEST",
    "id": 0,
    "action": {
        "name": "AttachLightTagLocation",
        "data": {
            "deviceAddress": "01:02:03:04:05:06",
            "location": "my nice location"
        }
    }
}

Detach Location (detachLocation)

This action resets the location of a Light Tag. The Light Tag will not trigger anymore.

  • deviceAddress: (string) MAC address of the device. Can be scanned from the QR Code on the Light Tag
{
    "type": "GENERAL_REQUEST",
    "id": 0,
    "action": {
        "name": "DetachLightTagLocation",
        "data": {
            "deviceAddress": "01:02:03:04:05:06"
        }
    }
}