Class ClaimingProtoHelper

Helper class for encoding/decoding claiming protobuf messages. This is a simplified implementation that creates/parses the proto format.

Index

Constructors

Methods

createClaimAbortRequest createClaimInitContinueRequest createClaimInitRequest createClaimStartRequest createClaimVerifyRequest extractPayloadString getOffset getTotalLen isSuccess parseClaimResponse

Constructors

constructor

new ClaimingProtoHelper(): ClaimingProtoHelper
Returns ClaimingProtoHelper

Methods

`Static`createClaimAbortRequest

createClaimAbortRequest(): Uint8Array
Creates a ClaimAbort command payload.

Returns Uint8Array
Uint8Array payload
- Defined in src/proto/esp_rmaker_claim.ts:149

`Static`createClaimInitContinueRequest

createClaimInitContinueRequest(): Uint8Array
Creates a ClaimInit request to get more CSR data (continuation request).

Returns Uint8Array
Uint8Array payload
- Defined in src/proto/esp_rmaker_claim.ts:112

`Static`createClaimInitRequest

createClaimInitRequest(data: string): Uint8Array
Creates a ClaimInit command payload with data from cloud.
Parameters
- data: string
  The data string to send (from cloud initiate response)
Returns Uint8Array
Uint8Array payload
- Defined in src/proto/esp_rmaker_claim.ts:90

`Static`createClaimStartRequest

createClaimStartRequest(): Uint8Array
Creates a ClaimStart command payload. Android sends: msg=TypeCmdClaimStart + empty cmdPayload

Returns Uint8Array
Uint8Array payload
- Defined in src/proto/esp_rmaker_claim.ts:76

`Static`createClaimVerifyRequest

createClaimVerifyRequest(
    certificateData: string,
    offset: number,
    chunkSize: number,
): Uint8Array
Creates a ClaimVerify command payload with certificate data.
Parameters
- certificateData: string
  The certificate string to send
- offset: number
  Current offset for chunked transfer
- chunkSize: number
  Size of each chunk
Returns Uint8Array
Uint8Array payload
- Defined in src/proto/esp_rmaker_claim.ts:128

`Static`extractPayloadString

extractPayloadString(response: RMakerClaimPayload): string
Extracts the payload string from a response.
Parameters
- response: RMakerClaimPayload
  The parsed response
Returns string
The payload as a string, or empty string if not available
- Defined in src/proto/esp_rmaker_claim.ts:222

`Static`getOffset

getOffset(response: RMakerClaimPayload): number
Gets the offset from a response.
Parameters
- response: RMakerClaimPayload
  The parsed response
Returns number
The offset value
- Defined in src/proto/esp_rmaker_claim.ts:234

`Static`getTotalLen

getTotalLen(response: RMakerClaimPayload): number
Gets the total length from a response.
Parameters
- response: RMakerClaimPayload
  The parsed response
Returns number
The total length value
- Defined in src/proto/esp_rmaker_claim.ts:243

`Static`isSuccess

isSuccess(response: RMakerClaimPayload): boolean
Checks if the response indicates success.
Parameters
- response: RMakerClaimPayload
  The parsed response
Returns boolean
true if status is Success
- Defined in src/proto/esp_rmaker_claim.ts:252

`Static`parseClaimResponse

parseClaimResponse(data: Uint8Array): RMakerClaimPayload
Parses a claiming response from the device.
Parameters
- data: Uint8Array
  The response data as Uint8Array
Returns RMakerClaimPayload
Parsed RMakerClaimPayload
- Defined in src/proto/esp_rmaker_claim.ts:163