Interface IGnpChannel

A communication channel to a device using the GNP protocol and a default address.

interface IGnpChannel {
    defaultAddress: Address;
    description: string;
    events: Observable<Packet>;
    type: ChannelType;
    read(request: Subcommand | IGnpRequest): Promise<PacketData>;
    sendEvent(request: Subcommand | IGnpRequest): void;
    withAddress(address: Address): IGnpChannel;
    write(request: Subcommand | IGnpRequest): Promise<void>;
}

Hierarchy (View Summary)

ICommunicationChannel
IGnp
- IGnpChannel

Index

Methods

read sendEvent withAddress write

Properties

defaultAddress description events type

Methods

read

read(request: Subcommand | IGnpRequest): Promise<PacketData>
Parameters
- request: Subcommand | IGnpRequest
Returns Promise<PacketData>
Overrides IGnp.read
- Defined in modules/core/src/gnp/IGnpChannel.ts:19

sendEvent

sendEvent(request: Subcommand | IGnpRequest): void
Parameters
- request: Subcommand | IGnpRequest
Returns void
Overrides IGnp.sendEvent
- Defined in modules/core/src/gnp/IGnpChannel.ts:23

withAddress

withAddress(address: Address): IGnpChannel
Parameters
- address: Address
Returns IGnpChannel
- Defined in modules/core/src/gnp/IGnpChannel.ts:25

write

write(request: Subcommand | IGnpRequest): Promise<void>
Parameters
- request: Subcommand | IGnpRequest
Returns Promise<void>
Overrides IGnp.write
- Defined in modules/core/src/gnp/IGnpChannel.ts:21

Properties

`Readonly`defaultAddress

defaultAddress: Address

`Readonly`description

description: string

A description of the purpose of the communication channel.

`Readonly`events

events: Observable<Packet>

`Readonly`type

type: ChannelType

The type of the communication channel type.