Set proximity sensor settings

• Configures proximity sensor settings. There are two modes: adaptive - sensor adapts to walls and obstacles around and all_time - sensor is triggering all time when object is detected
• It wakes up screen when triggered
• It will trigger face recognition screen if autostart option is enabled in POST /access/general/facerecognition
• It will trigger QR recognition screen if autostart option is enabled in POST /access/general/qr

application/json

Request Body required

• is_enabled boolean required
• mode string required

  Possible values: [adaptive, all_time]

  Modes:

  • adaptive - sensor adapts to walls and obstacles around
  • all_time - sensor is triggering all time when object is detected

Responses

• 200
• 400
• 401
• 403

---

OK

• Missed json body or wrong param. Response sample:

    "error": "Wrong JSON body"
• Required field is not provided. Response sample:

    "error": "Wrong JSON body: no value for `param`"
  where param - is a required field that was not provided
• Field was of the wrong type. Response sample:

    "error": "Wrong JSON body: value `param` was of the wrong type"
  where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• Missed param
• Wrong param type

---

Schema

• error string

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...