@opalkelly/frontpanel-platform-api/src/core/Endpoint.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";

/**
 * Type representing the address of an endpoint.
 */
export type EndpointAddress = number;

/**
 * Represents the address of a bit within an endpoint.
 */
export type EndpointBitAddress = {
    /**
     * The address of the endpoint.
     */
    epAddress: EndpointAddress;

    /**
     * The offset from the LSB of the endpoint, measured in bits.
     */
    bitOffset: BitCount;
};

/**
 * Type representing a Register address.
 */
export type RegisterAddress = number;

/**
 * Type representing the width of a Register address, measured in bits.
 */
export type RegisterAddressWidth = BitCount;

/**
 * Type representing Register data.
 */
export type RegisterData = number;

/**
 * Type representing the width of Register data, measured in bits.
 */
export type RegisterDataWidth = BitCount;