Class OsService

Embedded OS API service

Hierarchy (View Summary)

BaseEmbedService
- OsService

Index

Constructors

Methods

batch buildOptionsWithRequest factorySettings indicate loadCode read readTrConfig reset restart rfpgm selectiveBatch setSecurity sleep testRfSignal writeTrConfig writeTrConfigByte

Constructors

constructor

new OsService(): OsService
Returns OsService
Inherited from BaseEmbedService.constructor

Methods

`Static`batch

batch(
    shared: EmbedSharedParams,
    params: BatchParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Execute batch of requests
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: BatchParams
  Batch request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:35

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`factorySettings

factorySettings(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Perform factory reset
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:53

`Static`indicate

indicate(
    shared: EmbedSharedParams,
    params: IndicateParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Indicate node
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: IndicateParams
  Indicate request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:69

`Static`loadCode

loadCode(
    shared: EmbedSharedParams,
    params: LoadCodeParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Load code to flash
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: LoadCodeParams
  LoadCode request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:85

`Static`read

read(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Read OS data
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:100

`Static`readTrConfig

readTrConfig(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Read TR configuration
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:115

`Static`reset

reset(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Reset device
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:130

`Static`restart

restart(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Restart device
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:145

`Static`rfpgm

rfpgm(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Run RFPGM
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:160

`Static`selectiveBatch

selectiveBatch(
    shared: EmbedSharedParams,
    params: SelectiveBatchParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Execute batch of requests on specific nodes
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: SelectiveBatchParams
  Selective batch request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:176

`Static`setSecurity

setSecurity(
    shared: EmbedSharedParams,
    params: SetSecurityParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set security password or user key
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: SetSecurityParams
  Set security request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:196

`Static`sleep

sleep(
    shared: EmbedSharedParams,
    params: SleepParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Put device into sleep mode
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: SleepParams
  Sleep request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:212

`Static`testRfSignal

testRfSignal(
    shared: EmbedSharedParams,
    params: TestRfSignalParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Test RF signal
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: TestRfSignalParams
  Test RF signal request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:228

`Static`writeTrConfig

writeTrConfig(
    shared: EmbedSharedParams,
    params: EmbedTrConfigParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Write TR configuration
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedTrConfigParams
  Write TR configuration request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:244

`Static`writeTrConfigByte

writeTrConfigByte(
    shared: EmbedSharedParams,
    params: EmbedTrConfigByteParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Write TR configuration byte(s)
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedTrConfigByteParams
  Write TR configuration byte request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/OsService.ts:260

Class OsService

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns OsService

Methods

Staticbatch

Parameters

Returns DaemonMessageOptions

Protected StaticbuildOptionsWithRequest

Parameters

Returns DaemonMessageOptions

StaticfactorySettings

Parameters

Returns DaemonMessageOptions

Staticindicate

Parameters

Returns DaemonMessageOptions

StaticloadCode

Parameters

Returns DaemonMessageOptions

Staticread

Parameters

Returns DaemonMessageOptions

StaticreadTrConfig

Parameters

Returns DaemonMessageOptions

Staticreset

Parameters

Returns DaemonMessageOptions

Staticrestart

Parameters

Returns DaemonMessageOptions

Staticrfpgm

Parameters

Returns DaemonMessageOptions

StaticselectiveBatch

Parameters

Returns DaemonMessageOptions

StaticsetSecurity

Parameters

Returns DaemonMessageOptions

Staticsleep

Parameters

Returns DaemonMessageOptions

StatictestRfSignal

Parameters

Returns DaemonMessageOptions

StaticwriteTrConfig

Parameters

Returns DaemonMessageOptions

StaticwriteTrConfigByte

Parameters

Returns DaemonMessageOptions

Settings

On This Page

`Static`batch

`Protected` `Static`buildOptionsWithRequest

`Static`factorySettings

`Static`indicate

`Static`loadCode

`Static`read

`Static`readTrConfig

`Static`reset

`Static`restart

`Static`rfpgm

`Static`selectiveBatch

`Static`setSecurity

`Static`sleep

`Static`testRfSignal

`Static`writeTrConfig

`Static`writeTrConfigByte