@opalkelly/frontpanel-platform-api/src/core/TriggerEndpoint.ts

TypeScript definitions for Opal Kelly FrontPanel Platform API

/**
 * Copyright (c) 2024 Opal Kelly Incorporated
 *
 * This source code is licensed under the FrontPanel license.
 * See the LICENSE file found in the root directory of this project.
 */

import { BitCount } from "./CoreDataTypes";

import { EndpointAddress, EndpointBitAddress } from "./Endpoint";

/**
 * Type representing the address of a Trigger vector endpoint.
 */
export type TriggerVectorAddress = EndpointAddress;

/**
 * Type representing a Trigger vector.
 */
export type TriggerVector = number;

/**
 * Type representing the width of a Trigger vector, measured in bits.
 */
export type TriggerVectorWidth = BitCount;

/**
 * Type representing a Trigger vector mask.
 */
export type TriggerVectorMask = number;

/**
 * Type representing the state of a Trigger, which is a boolean.
 */
export type TriggerState = boolean;

/**
 * Type representing the address of a Trigger.
 */
export type TriggerAddress = EndpointBitAddress;