@iotize/device-client.js
Version:
IoTize Device client for Javascript
91 lines (90 loc) • 4.08 kB
TypeScript
/**
* This file has been generated
* DO NOT EDIT, IT MAY BE OVERWRITTEN
*/
import { Client, Response, ApiConfig } from "../import-adapter";
import { AbstractService, ServiceCallType } from '../abstract-service';
import { SinglePacketStoreInfo } from '../../all-models';
import { SinglePacketPart } from '../../all-models';
export declare class SinglePacketService extends AbstractService {
constructor(client: Client, apiConfig: ApiConfig);
resources: {
[key: string]: ServiceCallType;
};
/**
* Execute (after validation) a big Single Packet previously sent to the TAP using BSPP.
* Execute (after validation) a big Single Packet previously sent to the TAP using BSPP. Stored packet is erased after packet is executed. (even if failed to execute) This command contains some control information (size, hash, CRC, salt, etc.) TBD
* LWM2M path: /1024//83
* Body converter id: "integer_uint32"
* @tapVersion(">=1.13")
* @param data input
* @return void api call
*/
bspe(data: number): Promise<Response<void>>;
/**
* Execute (after validation) a big Single Packet previously sent to the TAP using BSPP.
* Execute (after validation) a big Single Packet previously sent to the TAP using BSPP. Stored packet is erased after packet is executed. (even if failed to execute) This command contains some control information (size, hash, CRC, salt, etc.) TBD
* LWM2M path: /1024//83
* Body converter id: "integer_uint32"
* @tapVersion(">=1.13")
* @param data input
* @return call options
*/
bspeCall(data: number): ServiceCallType;
/**
* Get information concerning Single Packet Store Status
* Get information concerning Single Packet Store Status : Does this TAP provide the Single Packet Store ? (SPS) Is the store empty, full or halfway ? Details about the the execution of the last executes SP ?
* LWM2M path: /1024//81
* @tapVersion(">=1.13")
* @return SinglePacketStoreInfo api call
*/
getInfo(): Promise<Response<SinglePacketStoreInfo>>;
/**
* Get information concerning Single Packet Store Status
* Get information concerning Single Packet Store Status : Does this TAP provide the Single Packet Store ? (SPS) Is the store empty, full or halfway ? Details about the the execution of the last executes SP ?
* LWM2M path: /1024//81
* @tapVersion(">=1.13")
* @return call options
*/
getInfoCall(): ServiceCallType;
/**
* Send a partial Single Packet to the TAP.
* Size of the packet = 130 bytes : 2 bytes offset, 128 bytes packet part. Stored packet is erased when packet part 0 is received.
* LWM2M path: /1024//82
* Body converter id: "SinglePacketPart"
* @tapVersion(">=1.13")
* @param data input
* @return void api call
*/
writePartialSinglePacket(data: SinglePacketPart): Promise<Response<void>>;
/**
* Send a partial Single Packet to the TAP.
* Size of the packet = 130 bytes : 2 bytes offset, 128 bytes packet part. Stored packet is erased when packet part 0 is received.
* LWM2M path: /1024//82
* Body converter id: "SinglePacketPart"
* @tapVersion(">=1.13")
* @param data input
* @return call options
*/
writePartialSinglePacketCall(data: SinglePacketPart): ServiceCallType;
/**
* Send a complete Small Single Packet to the TAP. Size of the packet < 120 bytes
*
* LWM2M path: /1024//80
* Body converter id: "Bytes"
* @tapVersion(">=1.13")
* @param data input
* @return Uint8Array api call
*/
writeSmallSinglePacket(data: Uint8Array): Promise<Response<Uint8Array>>;
/**
* Send a complete Small Single Packet to the TAP. Size of the packet < 120 bytes
*
* LWM2M path: /1024//80
* Body converter id: "Bytes"
* @tapVersion(">=1.13")
* @param data input
* @return call options
*/
writeSmallSinglePacketCall(data: Uint8Array): ServiceCallType;
}