Skip to content

Commit b99b751

Browse files
divipillaiDematteisGiacomo
authored andcommitted
doc: Add the Antenna Tuning on Thingy:91 X
Add the Antenna Tuning on Thingy:91 X Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent f5d219b commit b99b751

4 files changed

Lines changed: 36 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ This project is based on the
1515

1616
## Getting started
1717

18-
To get started with hello-nrfcloud firmware for the Thingy:91 X, follow [documentation](https://hello-nrfcloud.github.io/firmware/html/index.html).
18+
To get started with hello-nrfcloud firmware for the Thingy:91 X, follow [documentation](https://docs.nordicsemi.com/bundle/addon-nrfcloud_firmware-latest/page/index.html).

docs/antennatuning.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _hello_nrfcloud_antennatuning:
2+
3+
Antenna Tuning
4+
##############
5+
6+
The Thingy:91 X Hello nRF Cloud firmware uses the `Modem Antenna`_ library to configure the nRF9151’s MIPI RF Front-End Control Interface (RFFE) and the COEX pins.
7+
The Modem Antenna library uses the `%XMIPIRFFEDEV`_, `%XMIPIRFFECTRL`_, and `%COEXCONFIG`_ AT commands to send the configuration to the nRF9151 modem.
8+
The Thingy:91 X board files define the default AT commands that are sent to the modem using the following Kconfig options:
9+
10+
* ``CONFIG_MODEM_ANTENNA_AT_MIPIRFFEDEV``
11+
* ``CONFIG_MODEM_ANTENNA_AT_MIPIRFFECTRL_INIT``
12+
* ``CONFIG_MODEM_ANTENNA_AT_MIPIRFFECTRL_ON``
13+
* ``CONFIG_MODEM_ANTENNA_AT_MIPIRFFECTRL_OFF``
14+
* ``CONFIG_MODEM_ANTENNA_AT_MIPIRFFECTRL_PWROFF``
15+
* ``CONFIG_MODEM_ANTENNA_AT_COEX0``
16+
17+
The default values for the Kconfig options used when building firmware for the Thingy:91 X target can be found in the `Thingy:91 X nRF9151 board configuration`_ file.
18+
19+
You can modify the default values to optimize the antenna tuning of the Thingy:91 X for specific usage scenarios.
20+
Ignion, the manufacturer of the antenna used on the Thingy:91 X, explains in the `Ignion Antenna Technology Powering The-Nordic-Thingy 91 X`_ application note how the antenna tuning can be optimized for specific usage scenarios by adjusting the switching states of the antenna.
21+
22+
The antenna switch states can be set in the :file:`prj.conf` file by changing the configuration of the ``%XMIPIRFFECTRL`` AT command or during runtime by issuing the ``AT%XMIPIRFFECTRL=<new_antenna_switch_states>`` AT command.
23+
24+
.. important::
25+
Modification of the default configuration for the RF Front-End of the Thingy:91 X may result in radiated emissions outside regulatory limits.
26+
If you have a Thingy:91 X with a modified RF Front-End configuration, you must ensure that the operation of the modified Thingy:91 X complies with applicable regulatory requirements.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Read more about the various aspects of the firmware in the following sections.
2929
gsg_guide
3030
architecture
3131
led_indication
32+
antennatuning
3233
troubleshooting
3334
known_issues
3435
release_notes

docs/links.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
.. _`nRF Cloud CoAP`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/networking/nrf_cloud_coap.html
88
.. _`Date-Time`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/others/date_time.html
9+
.. _`Modem Antenna`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/modem/modem_antenna.html
910
.. _`connection manager`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/connectivity/networking/conn_mgr/main.html
1011
.. _`Fuel Gauge`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/hardware/peripherals/fuel_gauge.html
1112
.. _`BME68X IAQ driver`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/drivers/bme68x_iaq.html
@@ -17,13 +18,18 @@
1718
.. _`Installing nRF Util`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html
1819
.. _`Connectivity Bridge`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/applications/connectivity_bridge/README.html
1920
.. _`Thingy:91 X Recovery`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/device_guides/thingy91x/thingy91x_recover_to_factory_firmware.html
21+
.. _`%XMIPIRFFECTRL`: https://docs.nordicsemi.com/bundle/ref_at_commands_dect/page/REF/at_commands/sip_pin_configuration/xmipirffectrl.html
22+
.. _`%XMIPIRFFEDEV`: https://docs.nordicsemi.com/bundle/ref_at_commands_dect/page/REF/at_commands/sip_pin_configuration/xmipirffedev.html
23+
.. _`%COEXCONFIG`: https://docs.nordicsemi.com/bundle/ref_at_commands_dect/page/REF/at_commands/dect/coexconfig.html
24+
2025

2126
.. ### github.com
2227

2328
.. _`zcbor`: https://github.com/NordicSemiconductor/zcbor
2429
.. _`NCS Example Application`: https://github.com/nrfconnect/ncs-example-application
2530
.. _`sdk-nrf PR #19024`: https://github.com/nrfconnect/sdk-nrf/pull/19024
2631
.. _`github_release`: https://github.com/hello-nrfcloud/firmware/releases
32+
.. _`Thingy:91 X nRF9151 board configuration`: https://github.com/nrfconnect/sdk-nrf/blob/6f02c434bada82fec5e26418d5cd1e6c091a46d1/boards/nordic/thingy91x/Kconfig.defconfig.nrf9151#L83
2733

2834

2935
.. ### other
@@ -34,6 +40,8 @@
3440

3541
.. _`Interactive BOM PCA20065 1.0.0.`: https://htmlpreview.github.io/?https://github.com/hello-nrfcloud/firmware/blob/main/docs/pca20065_1_0_0.html
3642

43+
.. _`Ignion Antenna Technology Powering The-Nordic-Thingy 91 X`: https://ignion.io/files/AN_Ignion-antenna-technology-powering-the-nordic-thingy91x
44+
3745
.. _`nRF5340 application firmware`: https://github.com/hello-nrfcloud/firmware/releases/download/v2.0.1/connectivity-bridge-v2.0.1-thingy91x-nrf53-app.hex
3846
.. _`nRF5340 network firmware`: https://github.com/hello-nrfcloud/firmware/releases/download/v2.0.1/connectivity-bridge-v2.0.1-thingy91x-nrf53-net.hex
3947
.. _`nRF9151 firmware`: https://github.com/hello-nrfcloud/firmware/releases/download/v2.0.1/hello.nrfcloud.com-v2.0.1+debug-thingy91x-nrf91.hex

0 commit comments

Comments
 (0)