# MatterCommissioningStatusCodes


```
class MatterCommissioningStatusCodes : CommonStatusCodes
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [com.google.android.gms.common.api.CommonStatusCodes](https://developers.google.com/android/reference/com/google/android/gms/common/api/CommonStatusCodes.html) ||
|   | ↳ | [com.google.android.gms.home.matter.commissioning.MatterCommissioningStatusCodes](https://developers.home.google.com/reference/kotlin/com/google/android/gms/home/matter/commissioning/MatterCommissioningStatusCodes.md.txt) |

*** ** * ** ***

Status codes for Matter commissioning APIs, for use in `getStatusCode` and `getGoogleErrorCode`.

Inherits the shared codes from `CommonStatusCodes` --- notably `INTERNAL_ERROR` (8) --- and defines the Matter commissioning status codes in the range 49200 to 49235.

## Summary

| ### Nested types |
|---|
| `@IntDef(value = [CommonStatusCodes.INTERNAL_ERROR]) @Retention(value = RetentionPolicy.SOURCE) annotation MatterCommissioningStatusCodes.StatusCode` Status code constants defined by `MatterCommissioningStatusCodes` and inherited from `CommonStatusCodes`. |

| ### Constants |
|---|---|
| `const Int` | `ACL_CONFIGURATION_FAILURE = 49230` Failure while configuring Access Control Lists (ACLs) on the device. |
| `const Int` | `ATTESTATION_DAC_FAILURE = 49218` Device Attestation Certificate (DAC) was invalid or expired. |
| `const Int` | `ATTESTATION_ERROR = 49235` An error occurred during the device attestation process. |
| `const Int` | `ATTESTATION_PAA_INVALID = 49234` Product Attestation Authority (PAA) is invalid. |
| `const Int` | `ATTESTATION_PAA_UNREACHABLE_OR_REVOKED = 49220` GMS cannot reach Google to validate the PAA, or the certificate chain is revoked. |
| `const Int` | `ATTESTATION_PAI_INVALID = 49219` Product Attestation Intermediate (PAI) is missing, invalid, or doesn't match the DAC. |
| `const Int` | `CASE_SIGMA_HANDSHAKE_FAILURE = 49227` Failure during the Sigma 1-2-3 handshake while establishing the CASE session. |
| `const Int` | `COMMISSIONABLE_DISCOVERY_BLE_FAILURE = 49213` Failed to connect to the commissionee through BLE to establish PASE. |
| `const Int` | `COMMISSIONABLE_DISCOVERY_IP_FAILURE = 49214` Failed to connect to device through IP to establish PASE. |
| `const Int` | `COMMISSIONABLE_DISCOVERY_NO_DEVICES_FOUND = 49212` The device was not detected over BLE or mDNS to begin commissioning. |
| `const Int` | `COMMISSIONEE_FAILED_TO_JOIN_NETWORK = 49225` The Matter device was unable to connect to the Wi-Fi network with the provided credentials. |
| `const Int` | `COMMISSIONER_CREDENTIALS_FAILURE = 49208` Failure retrieving commissioner credentials. |
| `const Int` | `COMMISSIONER_WIFI_REQUIRED_FAILURE = 49202` The commissioning device has no active Wi-Fi connection. |
| `const Int` | `FABRIC_LIMIT_EXCEEDED = 49222` The device is already commissioned in the maximum allowed number of fabrics. |
| `const Int` | `FAIL_SAFE_TIMEOUT_REACHED = 49228` The Matter 'Fail-safe' timer expired before commissioning was finalized. |
| `const Int` | `GENERAL_NETWORK_FAILURE = 49231` A general failure sending RPCs or network packets during the finalization stage. |
| `const Int` | `GHP_ACCOUNT_NOT_FOUND = 49203` There was no GHP-linked account found for the app. |
| `const Int` | `GHP_HUB_ACTIVATION_FAILURE = 49207` The required Google Matter Hub failed to activate or bridge the session. |
| `const Int` | `GHP_INSUFFICIENT_USER_PERMISSIONS = 49205` User did not grant the app sufficient GHP permissions to commission this Matter device. |
| `const Int` | `GHP_MATTER_HUB_NOT_DETECTED = 49206` A Google Matter Hub is required for this device type but was not detected. |
| `const Int` | `GOOGLE_CONSENT_DENIED = 49204` User did not agree to connect this Matter device to their Google account. |
| `const Int` | `INVALID_COMMISSIONING_REQUEST = 49200` The commissioning request is malformed or contains invalid parameters. |
| `const Int` | `NEARBY_DEVICE_PERMISSION_DENIED = 49211` The user denied permission for the app to use Bluetooth or Location services. |
| `const Int` | `NOT_SPEC_COMPLIANT_DEVICE = 49221` The device is not compliant with the Matter specification based on its descriptors. |
| `const Int` | `OPERATIONAL_DISCOVERY_TIMEOUT_REACHED = 49229` The device could not be discovered via mDNS on the operational network after joining. |
| `const Int` | `PASE_CONNECTION_TIMEOUT = 49233` The PASE session timed out while establishing the connection to the device. |
| `const Int` | `PASE_PAKE_CRYPTO_FAILURE = 49217` A cryptographic failure during the PAKE (Password Authenticated Key Exchange) handshake. |
| `const Int` | `PASE_PASSCODE_INVALID = 49215` PASE session failed due to an incorrect passcode. |
| `const Int` | `QR_CODE_ALREADY_SCANNED = 49210` The QR code is valid, but has already been processed in an active or recent session. |
| `const Int` | `QR_CODE_INVALID = 49209` The QR code payload is malformed, not a valid Matter Base38 string, or version mismatch. |
| `const Int` | `RECEIVING_PBKDF_RESPONSE_FAILURE = 49216` Failure during the PBKDF (Password-Based Key Derivation Function) exchange. |
| `const Int` | `SETUP_CANCELED_BY_USER = 49232` The user canceled the commissioning flow. |
| `const Int` | `SETUP_PAYLOAD_NOT_FOUND = 49201` The setup payload (QR code or manual pairing code) could not be found. |
| `const Int` | `THREAD_JOIN_NETWORK_FAILURE = 49226` The device was unable to connect to the Thread mesh network. |
| `const Int` | `THREAD_NETWORK_NOT_FOUND = 49223` A Thread network is required for this device, but none was found in the home. |
| `const Int` | `THREAD_NO_BORDER_ROUTER_FOUND = 49224` No Thread Border Router (TBR) was found to bridge the Thread device to IP. |

| ### Public functions |
|---|---|
| `java-static String!` | `getStatusCodeString(statusCode: Int)` Returns an untranslated debug (not user-friendly!) string based on the current status code. |

### Inherited Constants

From [com.google.android.gms.common.api.CommonStatusCodes](https://developers.google.com/android/reference/com/google/android/gms/common/api/CommonStatusCodes.html) `const Int` `API_NOT_CONNECTED = 17` `const Int` `CANCELED = 16` `const Int` `CONNECTION_SUSPENDED_DURING_CALL = 20` `const Int` `DEAD_CLIENT = 18` `const Int` `DEVELOPER_ERROR = 10` `const Int` `ERROR = 13` `const Int` `INTERNAL_ERROR = 8` `const Int` `INTERRUPTED = 14` `const Int` `INVALID_ACCOUNT = 5` `const Int` `NETWORK_ERROR = 7` `const Int` `RATE_LIMIT_EXCEEDED = 23` `const Int` `RECONNECTION_TIMED_OUT = 22` `const Int` `RECONNECTION_TIMED_OUT_DURING_UPDATE = 21` `const Int` `REMOTE_EXCEPTION = 19` `const Int` `RESOLUTION_REQUIRED = 6` `const Int` `SERVICE_DISABLED = 3`

**This property is deprecated.**
`const Int` `SERVICE_VERSION_UPDATE_REQUIRED = 2`

**This property is deprecated.**
`const Int` `SIGN_IN_REQUIRED = 4` `const Int` `SUCCESS = 0` `const Int` `SUCCESS_CACHE = -1` `const Int` `TIMEOUT = 15`

### Inherited functions

From [com.google.android.gms.common.api.CommonStatusCodes](https://developers.google.com/android/reference/com/google/android/gms/common/api/CommonStatusCodes.html) `java-static String!` `getStatusCodeString(statusCode: Int)`

## Constants

### ACL_CONFIGURATION_FAILURE

```
const val ACL_CONFIGURATION_FAILURE = 49230: Int
```

Failure while configuring Access Control Lists (ACLs) on the device.

### ATTESTATION_DAC_FAILURE

```
const val ATTESTATION_DAC_FAILURE = 49218: Int
```

Device Attestation Certificate (DAC) was invalid or expired.

### ATTESTATION_ERROR

```
const val ATTESTATION_ERROR = 49235: Int
```

An error occurred during the device attestation process.

### ATTESTATION_PAA_INVALID

```
const val ATTESTATION_PAA_INVALID = 49234: Int
```

Product Attestation Authority (PAA) is invalid.

### ATTESTATION_PAA_UNREACHABLE_OR_REVOKED

```
const val ATTESTATION_PAA_UNREACHABLE_OR_REVOKED = 49220: Int
```

GMS cannot reach Google to validate the PAA, or the certificate chain is revoked.

### ATTESTATION_PAI_INVALID

```
const val ATTESTATION_PAI_INVALID = 49219: Int
```

Product Attestation Intermediate (PAI) is missing, invalid, or doesn't match the DAC.

### CASE_SIGMA_HANDSHAKE_FAILURE

```
const val CASE_SIGMA_HANDSHAKE_FAILURE = 49227: Int
```

Failure during the Sigma 1-2-3 handshake while establishing the CASE session.

### COMMISSIONABLE_DISCOVERY_BLE_FAILURE

```
const val COMMISSIONABLE_DISCOVERY_BLE_FAILURE = 49213: Int
```

Failed to connect to the commissionee through BLE to establish PASE.

### COMMISSIONABLE_DISCOVERY_IP_FAILURE

```
const val COMMISSIONABLE_DISCOVERY_IP_FAILURE = 49214: Int
```

Failed to connect to device through IP to establish PASE.

### COMMISSIONABLE_DISCOVERY_NO_DEVICES_FOUND

```
const val COMMISSIONABLE_DISCOVERY_NO_DEVICES_FOUND = 49212: Int
```

The device was not detected over BLE or mDNS to begin commissioning.

### COMMISSIONEE_FAILED_TO_JOIN_NETWORK

```
const val COMMISSIONEE_FAILED_TO_JOIN_NETWORK = 49225: Int
```

The Matter device was unable to connect to the Wi-Fi network with the provided credentials.

### COMMISSIONER_CREDENTIALS_FAILURE

```
const val COMMISSIONER_CREDENTIALS_FAILURE = 49208: Int
```

Failure retrieving commissioner credentials.

### COMMISSIONER_WIFI_REQUIRED_FAILURE

```
const val COMMISSIONER_WIFI_REQUIRED_FAILURE = 49202: Int
```

The commissioning device has no active Wi-Fi connection.

### FABRIC_LIMIT_EXCEEDED

```
const val FABRIC_LIMIT_EXCEEDED = 49222: Int
```

The device is already commissioned in the maximum allowed number of fabrics.

### FAIL_SAFE_TIMEOUT_REACHED

```
const val FAIL_SAFE_TIMEOUT_REACHED = 49228: Int
```

The Matter 'Fail-safe' timer expired before commissioning was finalized.

### GENERAL_NETWORK_FAILURE

```
const val GENERAL_NETWORK_FAILURE = 49231: Int
```

A general failure sending RPCs or network packets during the finalization stage.

### GHP_ACCOUNT_NOT_FOUND

```
const val GHP_ACCOUNT_NOT_FOUND = 49203: Int
```

There was no GHP-linked account found for the app.

### GHP_HUB_ACTIVATION_FAILURE

```
const val GHP_HUB_ACTIVATION_FAILURE = 49207: Int
```

The required Google Matter Hub failed to activate or bridge the session.

### GHP_INSUFFICIENT_USER_PERMISSIONS

```
const val GHP_INSUFFICIENT_USER_PERMISSIONS = 49205: Int
```

User did not grant the app sufficient GHP permissions to commission this Matter device.

### GHP_MATTER_HUB_NOT_DETECTED

```
const val GHP_MATTER_HUB_NOT_DETECTED = 49206: Int
```

A Google Matter Hub is required for this device type but was not detected.

### GOOGLE_CONSENT_DENIED

```
const val GOOGLE_CONSENT_DENIED = 49204: Int
```

User did not agree to connect this Matter device to their Google account.

### INVALID_COMMISSIONING_REQUEST

```
const val INVALID_COMMISSIONING_REQUEST = 49200: Int
```

The commissioning request is malformed or contains invalid parameters.

### NEARBY_DEVICE_PERMISSION_DENIED

```
const val NEARBY_DEVICE_PERMISSION_DENIED = 49211: Int
```

The user denied permission for the app to use Bluetooth or Location services.

### NOT_SPEC_COMPLIANT_DEVICE

```
const val NOT_SPEC_COMPLIANT_DEVICE = 49221: Int
```

The device is not compliant with the Matter specification based on its descriptors.

### OPERATIONAL_DISCOVERY_TIMEOUT_REACHED

```
const val OPERATIONAL_DISCOVERY_TIMEOUT_REACHED = 49229: Int
```

The device could not be discovered via mDNS on the operational network after joining.

### PASE_CONNECTION_TIMEOUT

```
const val PASE_CONNECTION_TIMEOUT = 49233: Int
```

The PASE session timed out while establishing the connection to the device.

### PASE_PAKE_CRYPTO_FAILURE

```
const val PASE_PAKE_CRYPTO_FAILURE = 49217: Int
```

A cryptographic failure during the PAKE (Password Authenticated Key Exchange) handshake.

### PASE_PASSCODE_INVALID

```
const val PASE_PASSCODE_INVALID = 49215: Int
```

PASE session failed due to an incorrect passcode.

### QR_CODE_ALREADY_SCANNED

```
const val QR_CODE_ALREADY_SCANNED = 49210: Int
```

The QR code is valid, but has already been processed in an active or recent session.

### QR_CODE_INVALID

```
const val QR_CODE_INVALID = 49209: Int
```

The QR code payload is malformed, not a valid Matter Base38 string, or version mismatch.

### RECEIVING_PBKDF_RESPONSE_FAILURE

```
const val RECEIVING_PBKDF_RESPONSE_FAILURE = 49216: Int
```

Failure during the PBKDF (Password-Based Key Derivation Function) exchange.

### SETUP_CANCELED_BY_USER

```
const val SETUP_CANCELED_BY_USER = 49232: Int
```

The user canceled the commissioning flow.

### SETUP_PAYLOAD_NOT_FOUND

```
const val SETUP_PAYLOAD_NOT_FOUND = 49201: Int
```

The setup payload (QR code or manual pairing code) could not be found.

### THREAD_JOIN_NETWORK_FAILURE

```
const val THREAD_JOIN_NETWORK_FAILURE = 49226: Int
```

The device was unable to connect to the Thread mesh network.

### THREAD_NETWORK_NOT_FOUND

```
const val THREAD_NETWORK_NOT_FOUND = 49223: Int
```

A Thread network is required for this device, but none was found in the home.

### THREAD_NO_BORDER_ROUTER_FOUND

```
const val THREAD_NO_BORDER_ROUTER_FOUND = 49224: Int
```

No Thread Border Router (TBR) was found to bridge the Thread device to IP.

## Public functions

### getStatusCodeString

```
java-static fun getStatusCodeString(statusCode: Int): String!
```

Returns an untranslated debug (not user-friendly!) string based on the current status code.