summaryrefslogtreecommitdiff
path: root/.pio/libdeps/esp32-s3-n16r8/RF24/docs/atxmega.md
blob: 721c08885d007a5944293322a48bcfb3128dab6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# ATXMEGA

@tableofcontents

The RF24 driver can be build as a static library with Atmel Studio 7 in order to be included as any other library in another program for the XMEGA family.

Currently only the [ATXMEGA D3](https://www.microchip.com/wwwproducts/en/ATxmega64d3) family is implemented.

## Preparation

Create an empty GCC Static Library project in Atmel Studio 7.

As not all files are required, copy the following directory structure in the project:

```text
utility\
  ATXMegaD3\
    compatibility.c
    compatibility.h
    gpio.cpp
    gpio.h
    gpio_helper.c
    gpio_helper.h
    includes.h
    RF24_arch_config.h
    spi.cpp
    spi.h
nRF24L01.h
printf.h
RF24.cpp
RF24.h
RF24_config.h
```

## Usage

Add the library to your project!

In the file where the `main()` is put the following in order to update the millisecond functionality:

```cpp
ISR(TCE0_OVF_vect)
{
    update_milisec();
}
```

Declare the rf24 radio with `RF24 radio(XMEGA_PORTC_PIN3, XMEGA_SPI_PORT_C);`

1. First parameter is the CE pin which can be any available pin on the microcontroller.
2. Second parameter is the CS which can be on port C (**XMEGA_SPI_PORT_C**) or on port D (**XMEGA_SPI_PORT_D**).

Call the `__start_timer()` to start the millisecond timer.

@note The millisecond functionality is based on the TCE0 so don't use these pins as IO.

@note The operating frequency of the uC is 32MHz. If you have a different frequency, change the TCE0 registers appropriately in function `__start_timer()` in **compatibility.c** file for your frequency.