Files
Embedded-Hacking/0x0014a_cb/include/lora.h
T

65 lines
2.2 KiB
C

// MIT License
//
// Copyright (c) 2026 Kevin Thomas
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
// Author: Kevin Thomas
// Email: kevin@mytechnotalent.com
// GitHub: https://github.com/mytechnotalent
// File: lora.h
// Desc: Declares UART1 interface for the REYAX RYLR998 LoRa transceiver.
// Created: 2026
#ifndef LORA_H
#define LORA_H
#include <stdbool.h>
#include <stddef.h>
#include "hardware/uart.h"
#define LORA_UART uart1
#define LORA_BAUD 9600
#define LORA_TX_PIN 8
#define LORA_RX_PIN 9
/**
* @brief Initialize UART1 and configure the RYLR998 radio parameters.
* @param void No parameters.
* @return void No return value.
*/
void init_lora(void);
/**
* @brief Transmit a message over the LoRa link to the base station.
* @param msg Null-terminated message string to transmit.
* @return void No return value.
*/
void lora_send(const char *msg);
/**
* @brief Poll the UART receive buffer for a complete LoRa packet.
* @param payload_out Buffer receiving the extracted payload string.
* @param max_len Capacity of payload_out in bytes.
* @return true when a payload was extracted, false otherwise.
*/
bool lora_poll_packet(char *payload_out, size_t max_len);
#endif // LORA_H