English | 简体中文 | 繁體中文 | 日本語 | Deutsch | 한국어
The SX1268 sub-GHz radio transceiver is the ideal device for long range wireless applications. It is designed for long battery life with just 4.2 mA of active receive current consumption. The SX1268 can transmit up to +22 dBm at 490 MHz with highly efficient integrated power amplifiers.At 780 MHz, the SX1268 consumes less than 20 mA to transmit a +10 dBm signal at its antenna port.SX1268 supports LoRa modulation for LPWAN use cases and (G)FSK modulation for legacy use cases. It is highly configurable to meet different application requirements utilizing the LoRaWANTM standard or proprietary protocols.The device is designed to comply with the physical layer requirements of the LoRaWANTM specification released by the LoRa AllianceTM.The radio is suitable for systems targeting compliance with radio regulations including but not limited to China regulatory requirements and ETSI EN 300 220 (434 MHz).Continuous frequency coverage from 410 MHz to 810 MHz allows the support of the 490 and 780 MHz Chinese low-power short-range device bands.SX1268 can be used in smart meters, supply chain and logistics, building automation and so on.
LibDriver SX1268 is the full function driver of SX1268 launched by LibDriver.It provides functions of wireless sending, wireless receiving, cad, etc. LibDriver is MISRA compliant.
/src includes LibDriver SX1268 source files.
/interface includes LibDriver SX1268 SPI platform independent template.
/test includes LibDriver SX1268 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver SX1268 sample code.
/doc includes LibDriver SX1268 offline document.
/datasheet includes SX1268 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
Reference /interface SPI platform independent template and finish your platform SPI driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#include "driver_sx1268_lora.h"
uint8_t (*g_gpio_irq)(void) = NULL;
uint8_t res;
static uint8_t gs_rx_done;
static void a_callback(uint16_t type, uint8_t *buf, uint16_t len)
{
switch (type)
{
case SX1268_IRQ_TX_DONE :
{
sx1268_interface_debug_print("sx1268: irq tx done.\n");
break;
}
case SX1268_IRQ_RX_DONE :
{
uint16_t i;
sx1268_bool_t enable;
float rssi;
float snr;
sx1268_interface_debug_print("sx1268: irq rx done.\n");
/* get the status */
if (sx1268_lora_get_status((float *)&rssi, (float *)&snr) != 0)
{
return;
}
sx1268_interface_debug_print("sx1268: rssi is %0.1f.\n", rssi);
sx1268_interface_debug_print("sx1268: snr is %0.2f.\n", snr);
/* check the error */
if (sx1268_lora_check_packet_error(&enable) != 0)
{
return;
}
if ((enable == SX1268_BOOL_FALSE) && len)
{
for (i = 0; i < len; i++)
{
sx1268_interface_debug_print("%c", buf[i]);
}
sx1268_interface_debug_print("\n");
gs_rx_done = 1;
}
break;
}
case SX1268_IRQ_PREAMBLE_DETECTED :
{
sx1268_interface_debug_print("sx1268: irq preamble detected.\n");
break;
}
case SX1268_IRQ_SYNC_WORD_VALID :
{
sx1268_interface_debug_print("sx1268: irq valid sync word detected.\n");
break;
}
case SX1268_IRQ_HEADER_VALID :
{
sx1268_interface_debug_print("sx1268: irq valid header.\n");
break;
}
case SX1268_IRQ_HEADER_ERR :
{
sx1268_interface_debug_print("sx1268: irq header error.\n");
break;
}
case SX1268_IRQ_CRC_ERR :
{
sx1268_interface_debug_print("sx1268: irq crc error.\n");
break;
}
case SX1268_IRQ_CAD_DONE :
{
sx1268_interface_debug_print("sx1268: irq cad done.\n");
break;
}
case SX1268_IRQ_CAD_DETECTED :
{
sx1268_interface_debug_print("sx1268: irq cad detected.\n");
break;
}
case SX1268_IRQ_TIMEOUT :
{
sx1268_interface_debug_print("sx1268: irq timeout.\n");
break;
}
default :
{
break;
}
}
}
/* gpio init */
res = gpio_interrupt_init();
if (res != 0)
{
return 1;
}
g_gpio_irq = sx1268_lora_irq_handler;
/* lora init */
res = sx1268_lora_init(a_callback);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
/* set send mode */
res = sx1268_lora_set_send_mode();
if (res != 0)
{
(void)sx1268_lora_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
sx1268_interface_debug_print("sx1268: send %s.\n", "123");
/* send data */
res = sx1268_lora_send((uint8_t *)"123", strlen("123"));
if (res != 0)
{
(void)sx1268_lora_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
/* deinit */
res = sx1268_lora_deinit();
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 0;#include "driver_sx1268_lora.h"
uint8_t (*g_gpio_irq)(void) = NULL;
uint8_t res;
uint32_t timeout;
static uint8_t gs_rx_done;
static void a_callback(uint16_t type, uint8_t *buf, uint16_t len)
{
switch (type)
{
case SX1268_IRQ_TX_DONE :
{
sx1268_interface_debug_print("sx1268: irq tx done.\n");
break;
}
case SX1268_IRQ_RX_DONE :
{
uint16_t i;
sx1268_bool_t enable;
float rssi;
float snr;
sx1268_interface_debug_print("sx1268: irq rx done.\n");
/* get the status */
if (sx1268_lora_get_status((float *)&rssi, (float *)&snr) != 0)
{
return 1;
}
sx1268_interface_debug_print("sx1268: rssi is %0.1f.\n", rssi);
sx1268_interface_debug_print("sx1268: snr is %0.2f.\n", snr);
/* check the error */
if (sx1268_lora_check_packet_error(&enable) != 0)
{
return 1;
}
if ((enable == SX1268_BOOL_FALSE) && len)
{
for (i = 0; i < len; i++)
{
sx1268_interface_debug_print("%c", buf[i]);
}
sx1268_interface_debug_print("\n");
gs_rx_done = 1;
}
break;
}
case SX1268_IRQ_PREAMBLE_DETECTED :
{
sx1268_interface_debug_print("sx1268: irq preamble detected.\n");
break;
}
case SX1268_IRQ_SYNC_WORD_VALID :
{
sx1268_interface_debug_print("sx1268: irq valid sync word detected.\n");
break;
}
case SX1268_IRQ_HEADER_VALID :
{
sx1268_interface_debug_print("sx1268: irq valid header.\n");
break;
}
case SX1268_IRQ_HEADER_ERR :
{
sx1268_interface_debug_print("sx1268: irq header error.\n");
break;
}
case SX1268_IRQ_CRC_ERR :
{
sx1268_interface_debug_print("sx1268: irq crc error.\n");
break;
}
case SX1268_IRQ_CAD_DONE :
{
sx1268_interface_debug_print("sx1268: irq cad done.\n");
break;
}
case SX1268_IRQ_CAD_DETECTED :
{
sx1268_interface_debug_print("sx1268: irq cad detected.\n");
break;
}
case SX1268_IRQ_TIMEOUT :
{
sx1268_interface_debug_print("sx1268: irq timeout.\n");
break;
}
default :
{
break;
}
}
}
/* gpio init */
res = gpio_interrupt_init();
if (res != 0)
{
return 1;
}
g_gpio_irq = sx1268_lora_irq_handler;
/* lora init */
res = sx1268_lora_init(a_callback);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
/* start receiving */
sx1268_interface_debug_print("sx1268: start receiving...\n");
gs_rx_done = 0;
timeout = 3000;
/* start receive */
res = sx1268_lora_set_continuous_receive_mode();
if (res != 0)
{
(void)sx1268_lora_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
while ((timeout != 0) && (gs_rx_done == 0))
{
timeout--;
sx1268_interface_delay_ms(1000);
}
if (gs_rx_done == 0)
{
/* receive timeout */
sx1268_interface_debug_print("sx1268: receive timeout.\n");
(void)sx1268_lora_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
/* deinit */
res = sx1268_lora_deinit();
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 0;Online documents: https://www.libdriver.com/docs/sx1268/index.html.
Offline documents: /doc/html/index.html.
Please refer to CONTRIBUTING.md.
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
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.
Please send an e-mail to lishifenging@outlook.com.
