SmartHomeError

NUGU스마트홈에서 지원하고 있는 Error와 Exception에 대한 내용입니다. ServiceProvider는 SmartHomeBackendProxy 구현 시 아래 리스트를 참조하여 SmartHomeDevice 제어 및 상태 조회 시 발생하는 오류 혹은 예외상황에 맞는 error code를 응답해야 합니다.

Error Response Format

SmartHome의 Error는 SmartHomeBackendProxy에서 모든 처리가 불가한 Global-level error와 SmartHomeDevice 제어 시에 발생하는 다양한 원인의 Error인 Device-level error로 구분됩니다. 아래 Global-level error와 Device-level error의 예시 format을 참조해주세요.

Global-level error

Service Provider에 공통 exception으로 처리하고자 하는 경우 사용합니다.

1
2
3
4
5
6
7

{
  "requestId": "2019071712638a4378649347bdb21643127a0f6d83",
  "error": {
    "code": 401, // HTTP status code
    "message": "invalid token"
  }
}

1
2
3
4
5
6
7

{
  "requestId": "2019071712638a4378649347bdb21643127a0f6d83",
  "error": {
    "code": 429, // HTTP status code
    "message": "Too many requests, 요청 한도를 넘었니다."
  }
}

1
2
3
4
5
6
7

{
  "requestId": "2019071712638a4378649347bdb21643127a0f6d83",
  "error": {
    "code": 503, // HTTP status code
    "message": "Service Unavailable, 소프트웨어 업데이트 중입니다."
  }
}

Device-level error

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "requestId": "2019071712638a4378649347bdb21643127a0f6d83",
  "data": [
    {
      "resultCode": "NotSupportBrightnessControl",
      "smartHomeDevice": {
        ...
      },
      "errorProperties": {}
    },
    {
      "resultCode": "OK",
      "smartHomeDevice": {
        ...
      },
      "properties": {}
    }
  ]
}

Error List

Device-level error 발생 시에는 error 원인에 맞는 error code를 응답해야 합니다. 이 때 error code에 따라 함께 응답해야 하는 부가정보(error property)가 있는 경우도 있습니다. 아래 NUGU 스마트홈을 통해 제공할 수 있는 error case별 code와 error property를 참조하시기 바랍니다.