Class AdapterNvMemory

constructor

• new AdapterNvMemory(znp): AdapterNvMemory

• Parameters

  • znp: default

  Returns AdapterNvMemory

OptionalmemoryAlignment

deleteItem

• deleteItem(id): Promise<void>

• Deletes an NV memory item.

  Parameters

  • id: NvItemsIds

    NV item identifier.

  Returns Promise<void>

init

• init(): Promise<void>

• Initialize NV memory driver by examining target and determining memory alignment.

  Returns Promise<void>

readExtendedTableEntry

• readExtendedTableEntry(sysId, id, subId, offset?): Promise<Buffer>

• Reads extended table entry (used by Z-Stack 3.x+). NV tables within newer Z-Stack releases include 16-bit subId identifying table entries.

  Parameters

  • sysId: ZSTACK

    SimpleLink system identifier.
  • id: NvItemsIds

    NV item identifier.
  • subId: number

    Entry index.
  • Optionaloffset: number

    Data offset to read from.

  Returns Promise<Buffer>
• readExtendedTableEntry<T>(sysId, id, subId, offset?, useStruct?): Promise<T>

• Type Parameters

  • T extends BuiltStruct<Struct>

  Parameters

  • sysId: ZSTACK
  • id: NvItemsIds
  • subId: number
  • Optionaloffset: number
  • OptionaluseStruct: MemoryObjectFactory<T>

  Returns Promise<T>

readItem

• readItem(id, offset?): Promise<Buffer>

• Reads a variable-length item from NV memory and returns buffer object. Read can be offset as required.

  Parameters

  • id: NvItemsIds

    NV item identifier.
  • Optionaloffset: number

    Desired data offset to read from.

  Returns Promise<Buffer>
• readItem<R, T>(id, offset?, useStruct?): Promise<T>

• Reads a variable-length item from NV memory and creates a builds a requested struct.

  Type Parameters

  • R extends BuiltStruct<Struct>
  • T extends BuiltStruct<Struct> | BuiltTable<R, Table<R>>

  Parameters

  • id: NvItemsIds

    NV item identifier.
  • Optionaloffset: number

    Desired data offset to read from.
  • OptionaluseStruct: MemoryObjectFactory<T>

    Struct factory to use to wrap the data in.

  Returns Promise<T>

readTable

• readTable(mode, id, maxLength): Promise<Buffer[]>

• Reads a legacy NV table at defined index into raw Buffer object array. Providing maximum length is necessary in order to prevent invalid memory access.

  Parameters

  • mode: "legacy"

    Only legacy mode is supported with this signature.
  • id: NvItemsIds

    The item index at which the table starts.
  • maxLength: number

    Maximum number of items the table may contain.

  Returns Promise<Buffer[]>
• readTable<R, T>(mode, id, maxLength, useTable?): Promise<T>

• Reads a legacy table at defined index into a table structure covering struct entries. Providing maximum length is necessary in order to prevent invalid memory access.

  Type Parameters

  • R extends BuiltStruct<Struct>
  • T extends BuiltTable<R, Table<R>>

  Parameters

  • mode: "legacy"

    Only legacy mode is supported with this signature.
  • id: NvItemsIds

    The item index at which the table starts.
  • maxLength: number

    Maximum number of items the table may contain.
  • OptionaluseTable: MemoryObjectFactory<T>

    Table factory to spawn a table and populate with retrieved data.

  Returns Promise<T>
• readTable(mode, sysId, id, maxLength?): Promise<Buffer[]>

• Reads an extended (Z-Stack 3.x.0+) table into raw Buffer object array. Maximum length is optional since the table boundary can be detected automatically.

  Parameters

  • mode: "extended"

    Only extended mode is supported with this signature.
  • sysId: ZSTACK

    SimpleLink system identifier.
  • id: NvItemsIds

    Extended table NV index.
  • OptionalmaxLength: number

    Maximum number of entries to load from the table.

  Returns Promise<Buffer[]>
• readTable<R, T>(mode, sysId, id, maxLength?, useTable?): Promise<T>

• Reads an extended (Z-Stack 3.x.0+) table into a table structure covering struct entries. Maximum length is optional since the table boundary can be detected automatically.

  Type Parameters

  • R extends BuiltStruct<Struct>
  • T extends BuiltTable<R, Table<R>>

  Parameters

  • mode: "extended"

    Only extended mode is supported with this signature.
  • sysId: ZSTACK

    SimpleLink system identifier.
  • id: NvItemsIds

    Extended table NV index.
  • OptionalmaxLength: number

    Maximum number of entries to load from the table.
  • OptionaluseTable: MemoryObjectFactory<T>

    Table factory to spawn a table and populate with retrieved data.

  Returns Promise<T>

updateItem

• updateItem(id, data, autoInit?): Promise<void>

• Determines whether NV item is different from provided data and updates if necessary.

  Parameters

  • id: NvItemsIds

    NV item identifier.
  • data: Buffer

    Desired NV item value.
  • autoInit: boolean = true

    Whether NV item should be automatically initialized if not present.

  Returns Promise<void>

writeExtendedTableEntry

• writeExtendedTableEntry(sysId, id, subId, data, offset?, autoInit?): Promise<void>

• Writes extended table entry (user by Z-Stack 3.x+). NV tables within newer Z-Stack releases include 16-bit subId identifying table tnreis.

  Parameters

  • sysId: ZSTACK

    SimpleLink system identifier.
  • id: NvItemsIds

    NV item identifier.
  • subId: number

    Entry index.
  • data: Buffer

    Data to write to the table.
  • Optionaloffset: number

    Offset to write at.
  • autoInit: boolean = true

    Whether non-existent entry should be automatically initialized.

  Returns Promise<void>

writeItem

• writeItem(id, data, offset?, autoInit?): Promise<void>

• Writes data to adapter NV memory. Method fails if write fails.

  Parameters

  • id: NvItemsIds

    NV item identifier.
  • data: Buffer | SerializableMemoryObject

    Data to be written.
  • offset: number = 0

    Offset within NV item to write the data.
  • autoInit: boolean = true

    Whether NV item should be automatically initialized if not present.

  Returns Promise<void>

writeTable

• writeTable<R>(mode, id, table): Promise<void>

• Writes a struct-based table structure into a legacy NV memory position.

  Type Parameters

  • R extends BuiltStruct<Struct>

  Parameters

  • mode: "legacy"

    Only legacy mode is supported with this signature.
  • id: NvItemsIds

    Start NV item index.
  • table: BuiltTable<R>

    Table structure to write to NV memory.

  Returns Promise<void>
• writeTable<R>(mode, sysId, id, table): Promise<void>

• Writes a struct-based table structure into an extended NV memory position.

  Type Parameters

  • R extends BuiltStruct<Struct>

  Parameters

  • mode: "extended"

    Only extended mode is supported with this signature.
  • sysId: ZSTACK

    SimpleLink system identifier.
  • id: NvItemsIds

    Extended table NV item index.
  • table: BuiltTable<R>

    Table structure to write to NV memory.

  Returns Promise<void>