Interface IPortsFeature

interface IPortsFeature {
    createVirtualPort(
        portIdA: number,
        portIdB: number,
    ): Observable<AttachedIOAttachVirtualInboundMessage>;
    deleteVirtualPort(
        virtualPortId: number,
    ): Observable<AttachedIODetachInboundMessage>;
    getPortModeInformation<T extends PortModeInformationType>(
        portId: number,
        modeId: number,
        modeInformationType: T,
    ): Observable<
        PortModeInformationInboundMessage & { modeInformationType: T },
    >;
    getPortModes(portId: number): Observable<PortModeInboundMessage>;
    getPortValue<
        TTransformer extends void
        | IPortValueTransformer<unknown> = void,
    >(
        portId: number,
        modeId: number,
        transformer?: TTransformer,
    ): TTransformer extends IPortValueTransformer<R>
        ? Observable<R>
        : Observable<number[]>;
    onIoAttach(
        filterOptions?: OnIoAttachFilter,
    ): Observable<
        AttachedIoAttachInboundMessage
        | AttachedIOAttachVirtualInboundMessage,
    >;
    onIoAttach(
        filterOptions?: number,
    ): Observable<
        AttachedIoAttachInboundMessage
        | AttachedIOAttachVirtualInboundMessage,
    >;
    onIoDetach(
        filterOptions?: OnIoDetachFilter,
    ): Observable<AttachedIODetachInboundMessage>;
    onIoDetach(
        filterOptions?: number,
    ): Observable<AttachedIODetachInboundMessage>;
    portValueChanges<
        TTransformer extends void
        | IPortValueTransformer<unknown> = void,
    >(
        portId: number,
        modeId: number,
        deltaThreshold: TTransformer extends IPortValueTransformer<R> ? R : number,
        transformer?: TTransformer,
    ): TTransformer extends IPortValueTransformer<R>
        ? Observable<R>
        : Observable<number[]>;
}

Index

Methods

createVirtualPort deleteVirtualPort getPortModeInformation getPortModes getPortValue onIoAttach onIoDetach portValueChanges

Methods

createVirtualPort

createVirtualPort(
portIdA: number,
portIdB: number,
): Observable<AttachedIOAttachVirtualInboundMessage>
Creates a virtual port that merges two physical ports. Virtual ports can be used to control two motors in a synchronized way.
Parameters
- portIdA: number
- portIdB: number
Returns Observable<AttachedIOAttachVirtualInboundMessage>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:105

deleteVirtualPort

deleteVirtualPort(
virtualPortId: number,
): Observable<AttachedIODetachInboundMessage>
Deletes a virtual port.
Parameters
- virtualPortId: number
Returns Observable<AttachedIODetachInboundMessage>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:112

getPortModeInformation

getPortModeInformation<T extends PortModeInformationType>(
    portId: number,
    modeId: number,
    modeInformationType: T,
): Observable<
    PortModeInformationInboundMessage & { modeInformationType: T },
>
Reads information about a given mode for a given port (e.g. mode name ('absolutePosition', 'speed', etc.)) Stream completes when the response is received from the hub.
Type Parameters
- T extends PortModeInformationType
Parameters
- portId: number
- modeId: number
- modeInformationType: T
Returns Observable<PortModeInformationInboundMessage & { modeInformationType: T }>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:63

getPortModes

getPortModes(portId: number): Observable<PortModeInboundMessage>
Reads port modes and capabilities for a given port. Stream completes when the response is received from the hub.
Parameters
- portId: number
Returns Observable<PortModeInboundMessage>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:53

getPortValue

getPortValue<TTransformer extends void | IPortValueTransformer<unknown> = void>(
    portId: number,
    modeId: number,
    transformer?: TTransformer,
): TTransformer extends IPortValueTransformer<R>
    ? Observable<R>
    : Observable<number[]>
Reads raw port value for a given port and mode id. Stream completes when the response is received from the hub.
Type Parameters
- TTransformer extends void | IPortValueTransformer<unknown> = void
Parameters
- portId: number
  The port id to read the value for.
- modeId: number
  The mode id to read the value for.
- Optionaltransformer: TTransformer
  Optional transformer to convert the raw value into a value that can be used by the application (or read by humans).
Returns TTransformer extends IPortValueTransformer<R>
? Observable<R>
: Observable<number[]>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:77

onIoAttach

onIoAttach(
    filterOptions?: OnIoAttachFilter,
): Observable<
    AttachedIoAttachInboundMessage
    | AttachedIOAttachVirtualInboundMessage,
>
Emits when an io device is attached to a port. If portId is not specified, it will emit for all ports. Events are cached, so if you subscribe after an io device is attached, you will still get the event.
Parameters
- OptionalfilterOptions: OnIoAttachFilter
  Optional filter options. If not specified, all events will be emitted. Port id may be specified to filter by port.
Returns Observable<
AttachedIoAttachInboundMessage
| AttachedIOAttachVirtualInboundMessage,
>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:30
onIoAttach(
    filterOptions?: number,
): Observable<
    AttachedIoAttachInboundMessage
    | AttachedIOAttachVirtualInboundMessage,
>
Parameters
- OptionalfilterOptions: number
Returns Observable<
AttachedIoAttachInboundMessage
| AttachedIOAttachVirtualInboundMessage,
>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:34

onIoDetach

onIoDetach(
filterOptions?: OnIoDetachFilter,
): Observable<AttachedIODetachInboundMessage>
Emits when an io device is detached from a port. If portId is not specified, it will emit for all ports.
Parameters
- OptionalfilterOptions: OnIoDetachFilter
  Optional filter options. If not specified, all events will be emitted. Port id may be specified to filter by port.
Returns Observable<AttachedIODetachInboundMessage>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:43
onIoDetach(filterOptions?: number): Observable<AttachedIODetachInboundMessage>
Parameters
- OptionalfilterOptions: number
Returns Observable<AttachedIODetachInboundMessage>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:45

portValueChanges

portValueChanges<
    TTransformer extends void
    | IPortValueTransformer<unknown> = void,
>(
    portId: number,
    modeId: number,
    deltaThreshold: TTransformer extends IPortValueTransformer<R> ? R : number,
    transformer?: TTransformer,
): TTransformer extends IPortValueTransformer<R>
    ? Observable<R>
    : Observable<number[]>
Provides port value updates for a given port and mode id.
Type Parameters
- TTransformer extends void | IPortValueTransformer<unknown> = void
Parameters
- portId: number
  The port id to read the value for.
- modeId: number
  The mode id to read the value for.
- deltaThreshold: TTransformer extends IPortValueTransformer<R> ? R : number
  If the difference between the current value and the previous value is less than this threshold, the value will not be emitted.
- Optionaltransformer: TTransformer
  Optional transformer to convert the raw value into a value that can be used by the application (or read by humans).
Returns TTransformer extends IPortValueTransformer<R>
? Observable<R>
: Observable<number[]>
- Defined in lib/rxpoweredup/src/hub/i-ports-feature.ts:91

Interface IPortsFeature

Index

Methods

Methods

createVirtualPort

Parameters

Returns Observable<AttachedIOAttachVirtualInboundMessage>

deleteVirtualPort

Parameters

Returns Observable<AttachedIODetachInboundMessage>

getPortModeInformation

Type Parameters

Parameters

Returns Observable<PortModeInformationInboundMessage & { modeInformationType: T }>

getPortModes

Parameters

Returns Observable<PortModeInboundMessage>

getPortValue

Type Parameters

Parameters

Returns TTransformer extends IPortValueTransformer<R>
? Observable<R>
: Observable<number[]>

onIoAttach

Parameters

Returns Observable<
AttachedIoAttachInboundMessage
| AttachedIOAttachVirtualInboundMessage,
>

Parameters

Returns Observable<
AttachedIoAttachInboundMessage
| AttachedIOAttachVirtualInboundMessage,
>

onIoDetach

Parameters

Returns Observable<AttachedIODetachInboundMessage>

Parameters

Returns Observable<AttachedIODetachInboundMessage>

portValueChanges

Type Parameters

Parameters

Returns TTransformer extends IPortValueTransformer<R>
? Observable<R>
: Observable<number[]>

Settings

On This Page

Interface IPortsFeature

Index

Methods

Methods

createVirtualPort

Parameters

Returns Observable<AttachedIOAttachVirtualInboundMessage>

deleteVirtualPort

Parameters

Returns Observable<AttachedIODetachInboundMessage>

getPortModeInformation

Type Parameters

Parameters

Returns Observable<PortModeInformationInboundMessage & { modeInformationType: T }>

getPortModes

Parameters

Returns Observable<PortModeInboundMessage>

getPortValue

Type Parameters

Parameters

Returns TTransformer extends IPortValueTransformer<R> ? Observable<R> : Observable<number[]>

onIoAttach

Parameters

Returns Observable< AttachedIoAttachInboundMessage | AttachedIOAttachVirtualInboundMessage,>

Parameters

Returns Observable< AttachedIoAttachInboundMessage | AttachedIOAttachVirtualInboundMessage,>

onIoDetach

Parameters

Returns Observable<AttachedIODetachInboundMessage>

Parameters

Returns Observable<AttachedIODetachInboundMessage>

portValueChanges

Type Parameters

Parameters

Returns TTransformer extends IPortValueTransformer<R> ? Observable<R> : Observable<number[]>

Settings

On This Page

Returns TTransformer extends IPortValueTransformer<R>
? Observable<R>
: Observable<number[]>

Returns Observable<
AttachedIoAttachInboundMessage
| AttachedIOAttachVirtualInboundMessage,
>

Returns Observable<
AttachedIoAttachInboundMessage
| AttachedIOAttachVirtualInboundMessage,
>

Returns TTransformer extends IPortValueTransformer<R>
? Observable<R>
: Observable<number[]>