Raden RF500

Raden RF500

Device Type

Table of Contents

Test Connection

command: test:connection

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "test:connection"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Connection Successful"
}

Get Information

command: get:info

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:info"
}

Example Response:

HTTP/1.1 200 Ok

{
  "info": {
    "result": "success",
    "time": "2018-06-19 10:53:21",
    "dev_id": "xxxxxxxxxxxxxxxx",
    "edition": "2.500.251",
    "volume": 0,
    "weigen": 0,
    "ip": "192.168.20.20",
    "gateway": "192.168.20.1",
    "netmask": "255.255.255.0",
    "mac": "xx:xx:xx:xx:xx:xx",
    "max_managernum": 8,
    "managernum": 0,
    "max_faceregist": 1000,
    "real_faceregist": 2,
    "max_facerecord": 100000,
    "real_facerecord": 4,
    "max_employee": 13000,
    "real_employee": 2,
    "max_finger": 2000,
    "real_finger": 0,
    "max_other": 10000,
    "real_other": 0,
    "type": "FA100",
    "alg_edition": "3.1",
    "managerlock": false
  }
}

Admins

Get Admins

command: get:admins

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:admins"
}

Example Response:

HTTP/1.1 200 Ok

{
  "admins": [
    {
      "id": 222,
      "name": "ardalan amini",
      "card_num": "xxxxxxxxxx",
      "pass_word": "",
      "enter_type": "face",
      "authority": 0,
      "face_data": [
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx..."
      ]
    },
    ...
  ]
}

Set Admins

command: set:admins

Param Type Description
admins Admin[] -

Admin

Param Type Default Description
id Number - -
name String - -
[authority] 0 | 1 1 0: super administrator, 1: normal administrator
[card_num] String "0Xffffffff" -
[password] String "" -
face_data String[] - 18 face templates

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:admins",
  "params": {
    "admins": [
      {
        "id": 222,
        "name": "ardalan amini",
        "authority": 0,
        "face_data": [
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx..."
        ]
      },
      ...
    ]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "success"
}

Remove Admins

command: remove:admins

Param Type Description
admins Number[] -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "remove:admins",
  "params": {
    "admins": [222, ...]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "success"
}

Get Admin Authority

command: get:admin_authority

Param Type Description
admin Number -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:admin_authority",
  "params": {
    "admin": 222
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "authority": 0
}

Users

Get Users

gets the given users from device, in case no param given or the users is an empty array it will get all users

command: get:users

Param Type Description
[users] Number[] Users identification codes

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:users"
}

Example Response:

HTTP/1.1 200 Ok

{
  "users": [
    {
      "id": 1,
      "name": "ardalan amini",
      "authority": "0X11",
      "card_num": "xxxxxxxxxx",
      "check_type": "face",
      "opendoor_type": "face",
      "password": "",
      "alg_edition": "3.1",
      "sn": "xxxxxxxxxxxxxxxx",
      "photo": "xxx...",
      "face_data": [
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx...", "xxx...", "xxx...",
        "xxx...", "xxx..."
      ]
    },
    ...
  ]
}

Set Users

command: set:users

Param Type Description
users User[] -

User

Param Type Default Description
id Number - -
name String - maximum 17 characters
[authority] "0X11" | "0X55" | "0Xaa" "0X55" "0X11": Access control & Attendance, "0X55": Attendance only, "0Xaa": Access only
[card_num] String "0Xffffffff" -
check_type "face" | "card&face" | "card" | "num&password" - -
opendoor_type "face" | "card&face" | "card" | "num&password" - -
[password] String "" -
[photo] String "" base64 format
face_data String[] - 18 face templates

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:users",
  "params": {
    "users": [
      {
        "id": 1,
        "name": "ardalan amini",
        "authority": "0X11",
        "card_num": "xxxxxxxxxx",
        "check_type": "face",
        "opendoor_type": "face",
        "password": "",
        "alg_edition": "3.1",
        "sn": "xxxxxxxxxxxxxxxx",
        "photo": "xxx...",
        "face_data": [
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx...", "xxx...", "xxx...",
          "xxx...", "xxx..."
        ]
      },
      ...
    ]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "success"
}

Remove Users

removes the given users from device, in case no param given or the users is an empty array it will remove all users

command: remove:users

Param Type default Description
[users] Number[] [] Users identification codes

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "remove:users",
  "params": {
    "users": [222, ...]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "success"
}

Enroll Users

command: enroll:users

Param Type Description
users User[] -

User to enroll

Param Type Default Description
id Number - -
name String - maximum 17 characters
[authority] "0X11" | "0X55" "0X55" "0X11": Access control & Attendance, "0X55": Attendance only
[dutyrule] 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 1 1: Face, 2: Card, 3: Card and Photo, 4: Card and Face, 5: ID and Face, 6: Card or Face, 7: Card or Pin, 8: ID and Pin, 9: Face and Fingerprint, 10: Face or Fingerprint, 11: Fingerprint
[photo] Boolean false true: Capture head photo, false: Don‟t capture head photo
[save] 1 | 2 | 3 1 1: Only save user data to the device, 2: Only send back user data to PC, 3: Save user data to the device and send back user data to PC

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "enroll:users",
  "params": {
    "users": [
      {
        "id": 1,
        "name": "ardalan amini",
        "authority": "0X11",
        "card_num": "xxxxxxxxxx",
        "check_type": "face",
        "opendoor_type": "face",
        "password": "",
        "alg_edition": "3.1",
        "sn": "xxxxxxxxxxxxxxxx",
        "photo": "xxx...",
      },
      ...
    ]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "success"
}

Get User Photo

command: get:user_photo

Param Type Description
user Number User’s identification code

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:user_photo",
  "params": {
    "user": 1
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "photo": "xxx..."
}

Set User Photo

command: set:user_photo

Param Type Description
user Number User’s identification code
photo String base64 format

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:user_photo",
  "params": {
    "user": 1,
    "photo": "xxx..."
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Clockings

Get Clockings

command: get:clockings

Param Type Description
[from] String date (YYYY-MM-DD)
[to] String date (YYYY-MM-DD)

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:clockings",
  "params": {
    "from": "2018-06-01",
    "to": "2018-06-17"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "dev_id": "xxxxxxxxxxxxxxxx",
  "total": x,
  "message": "success",
  "clockings": [
    {
      "user_id": 1,
      "name": "ardalan amini",
      "datetime": "2018-06-01 08:00:00",
      "workcode": x,
      "status": x,
      "authority": "0X11",
      "card_src": "from_check"
    },
    ...
  ]
}

Remove Clockings

command: remove:clockings

Param Type Description
[from] String date (YYYY-MM-DD)
[to] String date (YYYY-MM-DD)

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "remove:clockings",
  "params": {
    "from": "2018-06-01",
    "to": "2018-06-17"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Mark Clockings

Removes device’s sended clockings

command: mark:clockings

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "mark:clockings"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Datetime

Get Datetime

command: get:datetime

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:datetime"
}

Example Response:

HTTP/1.1 200 Ok

{
  "datetime": "2018-07-14 12:03:50"
}

Set Datetime

command: set:datetime

Param Type Default Description
[datetime] String now YYYY-MM-DD HH:mm:ss

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:datetime"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Workcodes

Get Workcodes

command: get:workcodes

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:workcodes"
}

Example Response:

HTTP/1.1 200 Ok

{
  "workcodes": [
    {
      "id": 1,
      "name": "normal"
    },
    ...
  ]
}

Set Workcodes

command: set:workcodes

Param Type Description
workcodes Workcode[] -

Workcode

Param Type Description
id Number -
name String -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:workcodes",
  "params": {
    "workcodes": [
      {
        "id": 1,
        "name": "normal"
      },
      ...
    ]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Remove Workcodes

command: remove:workcodes

Param Type Description
workcodes Number[] workcode ids

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "remove:workcodes",
  "params": {
    "workcodes": [1, ...]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Workstatus

Get Workstatus

command: get:workstatus

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:workstatus"
}

Example Response:

HTTP/1.1 200 Ok

{
  "workstatus": [
    {
      "id": 1,
      "name": "in"
    },
    ...
  ]
}

Set Workstatus

command: set:workstatus

Param Type Description
workstatus Workstatus Object[] -

Workstatus Object

Param Type Description
id Number -
name String -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:workstatus",
  "params": {
    "workstatus": [
      {
        "id": 1,
        "name": "in"
      },
      ...
    ]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Remove Workstatus

command: remove:workstatus

Param Type Description
workstatus Number[] workcode ids

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "remove:workstatus",
  "params": {
    "workstatus": [1, ...]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Security Photos

Set Security Photo

Enables/Disables the security photo function

command: set:sec_photo

Param Type Default Description
[enabled] Boolean true -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:sec_photo",
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Remove Security Photos

command: remove:sec_photos

Param Type Description
[from] String date (YYYY-MM-DD)
[to] String date (YYYY-MM-DD)

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "remove:sec_photos",
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Volume

Get Volume

command: get:volume

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:volume",
}

Example Response:

HTTP/1.1 200 Ok

{
  "volume": 1
}

Set Volume

command: set:volume

Param Type Description
volume 0 | 1 | 2 | 3 -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:volume",
  "params": {
    "volume": 1
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Bell

Get Bell

command: get:bell

Param Type Description
bell Number -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:bell",
  "params": {
    "bell": 1
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "bell": {
    "status": "enable",
    "bell_number": 0,
    "bell_sound": 1,
    "alarm_time": "09:00",
    "bell_time": 3,
    "bell_week": "1-1-1-1-1-0-0"
  }
}

Set Bell

command: set:bell

Param Type Description
bell Bell Object -

Bell Object

Param Type Default Description
bell_number Number - an integer: 0 < x < 23
bell_sound Number - an integer: 0 < x < 6
[status] "enable" | "disable" "enable" -
alarm_time String - time (HH:mm)
bell_time Number - an integer: 0 < x < 9
[bell_week] String "1-1-1-1-1-1-1" format: "x-x-x-x-x-x-x", x can only be 0 or 1, every x indicates bell is enabled or not for an specific day of week starting with monday

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:bell",
  "params": {
    "bell": {
      "bell_number": 0,
      "bell_sound": 1,
      "status": "enable",
      "alarm_time": "09:00",
      "bell_time": 3,
      "bell_week": "1-1-1-1-1-0-0"
    }
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Failed Recognition Alarm

command: set:fr_alarm

Param Type Default Description
[status] "enable" | "disable" "enable" -
[fr_times] Number 2 an integer: 1 < x < 9

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:fr_alarm",
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Temper Alarm

Get Temper Alarm

command: get:temper_alarm

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:temper_alarm"
}

Example Response:

HTTP/1.1 200 Ok

{
  "status": "enable"
}

Set Temper Alarm

command: set:temper_alarm

Param Type Default Description
[status] "enable" | "disable" "enable" -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:temper_alarm"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Magnet Alarm

Get Magnet Alarm

command: get:magnet_alarm

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:magnet_alarm"
}

Example Response:

HTTP/1.1 200 Ok

{
  "alarm": {
    "type": 0,
    "magnet_delay": 10,
    "status": "enable"
  }
}

Set Magnet Alarm

command: set:magnet_alarm

Param Type Description
alarm [Magnet Alarm Object][#magnet-alarm-object] -

Magnet Alarm Object

Param Type Default Description
type 0 | 1 | 2 - 0: none, 1: normally open, 2: normally closed
magnet_delay Number - an integer: 1 < x < 99
[status] "enable" | "disable" "enable" -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:magnet_alarm",
  "params": {
    "alarm": {
      "type": 0,
      "magnet_delay": 10
    }
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Daylight

Get Daylight

command: get:daylight

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:daylight"
}

Example Response:

HTTP/1.1 200 Ok

{
  "start_time": "5-10 2",
  "end_time": "11-10 2"
}

Set Daylight

command: set:daylight

Param Type Default Description
[support] 1 | 2 1 1: “Month-Day Hour”, 2: “Month-Week Weekdayth Hour”
start_time String - -
end_time String - -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:daylight",
  "params": {
    "start_time": "5-10 2",
    "end_time": "11-10 2"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Network Info

Get Network Info

command: get:net_info

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:net_info"
}

Example Response:

HTTP/1.1 200 Ok

{
  "info": {
    "ip": "192.168.20.20",
    "netmask": "255.255.255.0",
    "gateway": "192.168.20.1",
    "commukey": ""
  }
}

Set Network Info

command: set:net_info

Param Type Default Description
ip String - -
gateway String - -
[netmask] String "255.255.255.0" -
[commukey] String "" -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:net_info",
  "params": {
    "ip": "192.168.20.20",
    "gateway": "192.168.20.1"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Wiegand

Get Wiegand

command: get:wiegand

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:wiegand"
}

Example Response:

HTTP/1.1 200 Ok

{
  "pattern": "w26",
  "pulse_width": 100,
  "interval": 1600,
  "content": "card"
}

Set Wiegand

command: set:wiegand

Param Type Default Description
pattern "w26" | "w26_site" | "w34" | "w34_site" | "customize" - -
[pulse_width] Number 100 an integer: 20 < x < 800
[interval] Number 1000 an integer: 200 < x < 20000
content "id" | "card" - -
[site_code] String - -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:wiegand",
  "params": {
    "pattern": "w26",
    "pulse_width": 100,
    "interval": 1600,
    "content": "card"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Interval

Get Interval

command: get:interval

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:interval"
}

Example Response:

HTTP/1.1 200 Ok

{
  "interval": 2
}

Set Interval

command: set:interval

Param Type Description
interval Number an integer: 0 < x < 255

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:interval",
  "params": {
    "interval": 2
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Get Model

command: get:model

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:model"
}

Example Response:

HTTP/1.1 200 Ok

{
  "type": "F910"
}

Get Mac

command: get:mac

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:mac"
}

Example Response:

HTTP/1.1 200 Ok

{
  "mac": "00-0C-5B-02-EC-C5",
  "sn": "6714314090001858"
}

Get Capacity

command: get:capacity

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:capacity"
}

Example Response:

HTTP/1.1 200 Ok

{
  "max_managernum": 8,
  "managernum": 0,
  "max_faceregist": 2000,
  "real_faceregist": 126,
  "max_facerecord": 200000,
  "real_facerecord": 3286,
  "max_employee": 12000,
  "real_employee": 136,
  "max_other": 10000,
  "real_other": 10,
  "type": "F910",
  "alg_edition": "3.1"
}

Get Picture Names

gets picture names in YYMMDD/(OK|SORRY|CARD)/User ID/YYYYMMDDhhmmss format

command: get:picture_names

Param Type Description
[id] Number -
date String date (YYYY-MM-DD)
types ("face" | "photo" | "card")[] -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:picture_names",
  "params": {
    "time": "2014-05-08",
    "type": ["face", "photo", "card"]
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "names": [
    "140508/OK/3066/20140508110530.JPG",
    ...
  ]
}

Get Picture

command: get:picture

Param Type Description
name String -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "get:picture",
  "params": {
    "name": "140508/OK/3066/20140508110530.JPG"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "photo": "xxx..."
}

Set Server

command: set:server

Param Type Description
ip String -
tcpport Number -
udpport Number -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:server",
  "params": {
    "ip": "192.168.20.22",
    "tcpport": "9901",
    "udpport": "9902"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Access Sync

command: set:access_sync

Param Type Default Description
sync Boolean true -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:access_sync"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Relay Time

command: set:relay_time

Param Type Description
time Number an integer: 0 < x < 10

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:relay_time",
  "params": {
    "time": 8
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Relay Output

command: set:relay_output

Param Type Description
status 1 | 2 1: Bell, 2: Alarm

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:relay_output",
  "params": {
    "status": 1
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Duplication Check

command: set:duplication_check

Param Type Default Description
[status] "enable" | "disable" "enable" -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:duplication_check"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Photo Display

command: set:photo_display

Param Type Default Description
[status] "enable" | "disable" "enable" -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:photo_display"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Set Photo Prompt

command: set:photo_prompt

Param Type Default Description
[status] "enable" | "disable" "enable" -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "set:photo_prompt"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Restart Device

command: restart:device

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "restart:device"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Reset Device

command: reset:device

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "reset:device"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Upgrade Device

command: upgrade:device

Param Type Description
url String -
type String -
edition String -
md5check String -

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "upgrade:device",
  "params": {
    "url": "http://192.168.20.249/upgrade/xxx.BIN",
    "type": "xxx",
    "edition": "2.910.194",
    "md5check": "e7a2ed67c8abe0f83b2f492491837d38"
  }
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}

Check Upgrade Status

command: check:upgrade_status

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "check:upgrade_status"
}

Example Response:

HTTP/1.1 200 Ok

{
  "status": 100
}

Open Door

command: open:door

no params

Example Request:

{
  "device": {
    "host": "192.168.20.20",
    "type": "RadenRF500",
    "password": "123"
  },
  "command": "open:door"
}

Example Response:

HTTP/1.1 200 Ok

{
  "message": "Successful"
}