Relay.h

Go to the documentation of this file.

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
#pragma once
 
#include <stdint.h>
 
#include "hal/Types.h"
 
/**
 * @defgroup hal_relay Relay Output Functions
 * @ingroup hal_capi
 * @{
 */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**
 * Initializes a relay.
 *
 * Note this call will only initialize either the forward or reverse port of the
 * relay. If you need both, you will need to initialize 2 relays.
 *
 * @param[in] portHandle         the port handle to initialize
 * @param[in] fwd                true for the forward port, false for the
 *                               reverse port
 * @param[in] allocationLocation the location where the allocation is occurring
 *                               (can be null)
 * @param[out] status            Error status variable. 0 on success.
 * @return the created relay handle
 */
HAL_RelayHandle HAL_InitializeRelayPort(HAL_PortHandle portHandle, HAL_Bool fwd,
                                        const char* allocationLocation,
                                        int32_t* status);
 
/**
 * Frees a relay port.
 *
 * @param relayPortHandle the relay handle
 */
void HAL_FreeRelayPort(HAL_RelayHandle relayPortHandle);
 
/**
 * Checks if a relay channel is valid.
 *
 * @param channel the channel to check
 * @return true if the channel is valid, otherwise false
 */
HAL_Bool HAL_CheckRelayChannel(int32_t channel);
 
/**
 * Sets the state of a relay output.
 *
 * @param[in] relayPortHandle the relay handle
 * @param[in] on              true for on, false for off
 * @param[out] status         Error status variable. 0 on success.
 */
void HAL_SetRelay(HAL_RelayHandle relayPortHandle, HAL_Bool on,
                  int32_t* status);
 
/**
 * Gets the current state of the relay channel.
 *
 * @param[in] relayPortHandle the relay handle
 * @param[out] status         Error status variable. 0 on success.
 * @return true for on, false for off
 */
HAL_Bool HAL_GetRelay(HAL_RelayHandle relayPortHandle, int32_t* status);
#ifdef __cplusplus
}  // extern "C"
#endif
/** @} */