Skip to content

Commit

Permalink
samples: Fix printing welcome message example->sample
Browse files Browse the repository at this point in the history
Align code and documentation with the NCS naming.

Ref. NCSDK-30029

Signed-off-by: Michał Grochala <[email protected]>
  • Loading branch information
grochu authored and rlubos committed Jan 21, 2025
1 parent a862cb4 commit 188c9aa
Show file tree
Hide file tree
Showing 50 changed files with 58 additions and 58 deletions.
2 changes: 1 addition & 1 deletion samples/bluetooth/central_and_peripheral_hr/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ int main(void)
int err;
int blink_status = 0;

printk("Starting Bluetooth Central and Peripheral Heart Rate relay example\n");
printk("Starting Bluetooth Central and Peripheral Heart Rate relay sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_bas/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ int main(void)
{
int err;

printk("Starting Bluetooth Central BAS example\n");
printk("Starting Bluetooth Central BAS sample\n");

bt_bas_client_init(&bas);

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_hids/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ int main(void)
{
int err;

printk("Starting Bluetooth Central HIDS example\n");
printk("Starting Bluetooth Central HIDS sample\n");

bt_hogp_init(&hogp, &hogp_init_params);

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_hr_coded/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ int main(void)
{
int err;

printk("Starting Bluetooth Central HR coded example\n");
printk("Starting Bluetooth Central HR coded sample\n");

err = bt_enable(NULL);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_nfc_pairing/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ int main(void)
{
int err;

printk("Starting NFC Central Pairing example\n");
printk("Starting NFC Central Pairing sample\n");

/* Configure buttons */
err = dk_buttons_init(button_changed);
Expand Down
4 changes: 2 additions & 2 deletions samples/bluetooth/central_smp_client/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Testing
1. |connect_kit|
#. |connect_terminal|
#. Reset the kit.
#. Observe that the text "Starting Bluetooth Central SMP Client example" is printed on the COM listener running on the computer and the device starts scanning for Peripherals with SMP.
#. Observe that the text "Starting Bluetooth Central SMP Client sample" is printed on the COM listener running on the computer and the device starts scanning for Peripherals with SMP.
#. Program the :zephyr:code-sample:`smp-svr` to another development kit.
See the documentation for that sample only in the section "Building the sample application".
When you have built the sample, run the following command to program it to the development kit::
Expand All @@ -102,7 +102,7 @@ Testing
1. |connect_kit|
#. |connect_terminal|
#. Reset the kit.
#. Observe that the text "Starting Bluetooth Central SMP Client example" is printed on the COM listener running on the computer and the device starts scanning for Peripherals with SMP.
#. Observe that the text "Starting Bluetooth Central SMP Client sample" is printed on the COM listener running on the computer and the device starts scanning for Peripherals with SMP.
#. Program the :zephyr:code-sample:`smp-svr` to another development kit.
See the documentation for that sample only in the section "Building the sample application".
When you have built the sample, run the following command to program it to the development kit::
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_smp_client/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ int main(void)
{
int err;

printk("Starting Bluetooth Central SMP Client example\n");
printk("Starting Bluetooth Central SMP Client sample\n");

bt_dfu_smp_init(&dfu_smp, &init_params);

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_uart/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Testing
#. |connect_terminal_specific|
#. Optionally, connect the RTT console to display debug messages. See :ref:`central_uart_debug`.
#. Reset the kit.
#. Observe that the text "Starting Bluetooth Central UART example" is printed on the COM listener running on the computer and the device starts scanning for Peripherals with NUS.
#. Observe that the text "Starting Bluetooth Central UART sample" is printed on the COM listener running on the computer and the device starts scanning for Peripherals with NUS.
#. Program the :ref:`peripheral_uart` sample to the second development kit.
See the documentation for that sample for detailed instructions.
#. Observe that the kits connect.
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/central_uart/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ int main(void)
return 0;
}

printk("Starting Bluetooth Central UART example\n");
printk("Starting Bluetooth Central UART sample\n");

err = bt_scan_start(BT_SCAN_TYPE_SCAN_ACTIVE);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/direct_test_mode/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ int main(void)
int err;
union dtm_tr_packet cmd;

printk("Starting Direct Test Mode example\n");
printk("Starting Direct Test Mode sample\n");

err = dtm_tr_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/event_trigger/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Sample output
The sample displays the data in the following format::

*** Booting nRF Connect SDK v3.4.99-ncs1-4802-g41e34920abf4 ***
Starting Event Trigger Example.
Starting Event Trigger Sample.
I: SoftDevice Controller build revision:
I: ba cb 53 9c e2 c9 de b6 |..S.....
I: 82 1d 9c b3 eb de c5 1f |........
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/event_trigger/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ int main(void)

k_work_init(&work, work_handler);
console_init();
printk("Starting Event Trigger Example.\n");
printk("Starting Event Trigger Sample.\n");

err = bt_enable(NULL);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/fast_pair/input_device/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ int main(void)
bool run_led_on = true;
int err;

LOG_INF("Starting Bluetooth Fast Pair input device example");
LOG_INF("Starting Bluetooth Fast Pair input device sample");

/* Switch to the cooperative thread context before interaction
* with the Fast Pair API.
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/fast_pair/locator_tag/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -616,7 +616,7 @@ int main(void)
{
int err;

LOG_INF("Starting Bluetooth Fast Pair locator tag example");
LOG_INF("Starting Bluetooth Fast Pair locator tag sample");

if (IS_ENABLED(CONFIG_APP_DFU)) {
app_dfu_fw_version_log();
Expand Down
4 changes: 2 additions & 2 deletions samples/bluetooth/llpm/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ The result should look similar to the following output.
- For the central::

*** Booting Zephyr OS build v3.3.99-ncs1-2858-gc9d01d05ce83 ***
Starting Bluetooth LLPM example
Starting Bluetooth LLPM sample
I: SoftDevice Controller build revision:
I: 01 2d a8 d4 0d e5 25 cf |.-....%.
I: a3 48 8d 2f 56 e0 59 c8 |.H./V.Y.
Expand Down Expand Up @@ -242,7 +242,7 @@ The result should look similar to the following output.
- For the peripheral::

*** Booting Zephyr OS build v3.3.99-ncs1-2858-gc9d01d05ce83 ***
Starting Bluetooth LLPM example
Starting Bluetooth LLPM sample
I: SoftDevice Controller build revision:
I: 01 2d a8 d4 0d e5 25 cf |.-....%.
I: a3 48 8d 2f 56 e0 59 c8 |.H./V.Y.
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/llpm/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ int main(void)

console_init();

printk("Starting Bluetooth LLPM example\n");
printk("Starting Bluetooth LLPM sample\n");

err = bt_enable(NULL);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/multiple_adv_sets/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ int main(void)
int err;
int blink_status = 0;

printk("Starting Bluetooth multiple advertising sets example\n");
printk("Starting Bluetooth multiple advertising sets sample\n");

err = dk_leds_init();
if (err) {
Expand Down
4 changes: 2 additions & 2 deletions samples/bluetooth/nrf_dm/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ The result should look similar to the following output:
* The MCPD method::

*** Booting Zephyr OS build v2.6.99-ncs1 ***
Starting Distance Measurement example
Starting Distance Measurement sample
I: SoftDevice Controller build revision:
I: 3f 47 70 8e 81 95 4e 86 |?Gp...N.
I: 9d d3 a2 95 88 f6 30 0a |......0.
Expand Down Expand Up @@ -200,7 +200,7 @@ The result should look similar to the following output:
* The RTT method::

*** Booting Zephyr OS build v2.6.99-ncs1 ***
Starting Distance Measurement example
Starting Distance Measurement sample
I: SoftDevice Controller build revision:
I: 3f 47 70 8e 81 95 4e 86 |?Gp...N.
I: 9d d3 a2 95 88 f6 30 0a |......0.
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/nrf_dm/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ int main(void)
uint32_t blink_status = 0;
struct dm_init_param init_param;

printk("Starting Distance Measurement example\n");
printk("Starting Distance Measurement sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_ams_client/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ int main(void)
int blink_status = 0;
int err;

printk("Starting Apple Media Service client example\n");
printk("Starting Apple Media Service client sample\n");

err = bt_ams_client_init(&ams_c);
if (err) {
Expand Down
4 changes: 2 additions & 2 deletions samples/bluetooth/peripheral_ancs_client/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Testing with Bluetooth Low Energy app
Send an iOS notification to the application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following table shows the format of a notification that you can send to the example application:
The following table shows the format of a notification that you can send to the sample application:

+------------------+---------------+--------------------------+
| Field | Example value | Interpretation |
Expand Down Expand Up @@ -223,7 +223,7 @@ The following table shows the relevant part of a request to retrieve notificatio
| Length | 20 00 | 0x0020 |
+------------------+---------------+-----------------------------+

Note that the example application will request all existing attribute types, not only a subset.
Note that the sample application will request all existing attribute types, not only a subset.

The following table shows the format of a response that contains some of the requested notification attributes:

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_ancs_client/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ int main(void)
int blink_status = 0;
int err;

printk("Starting Apple Notification Center Service client example\n");
printk("Starting Apple Notification Center Service client sample\n");

err = ancs_c_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_bms/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ int main(void)
int blink_status = 0;
int err;

printk("Starting Bluetooth Peripheral BMS example\n");
printk("Starting Bluetooth Peripheral BMS sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_cgms/prj.conf
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ CONFIG_LOG=y
CONFIG_BT_CGMS_LOG_LEVEL_INF=y
CONFIG_SFLOAT=y

# This example requires more stack
# This sample requires more stack
CONFIG_MAIN_STACK_SIZE=1152
CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=1280
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_cgms/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ int main(void)
struct bt_cgms_cb cb;
struct bt_cgms_init_param params;

printk("Starting Bluetooth Peripheral CGM example\n");
printk("Starting Bluetooth Peripheral CGM sample\n");

bt_conn_auth_cb_register(&auth_cb_display);

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_cts_client/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ int main(void)
int blink_status = 0;
int err;

printk("Starting Current Time Service client example\n");
printk("Starting Current Time Service client sample\n");

err = bt_cts_client_init(&cts_c);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_gatt_dm/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ int main(void)
{
int err;

printk("Starting GATT Discovery Manager example\n");
printk("Starting GATT Discovery Manager sample\n");

err = dk_buttons_init(button_changed);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_hids_keyboard/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -940,7 +940,7 @@ int main(void)
int err;
int blink_status = 0;

printk("Starting Bluetooth Peripheral HIDS keyboard example\n");
printk("Starting Bluetooth Peripheral HIDS keyboard sample\n");

configure_gpio();

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_hids_mouse/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -784,7 +784,7 @@ int main(void)
{
int err;

printk("Starting Bluetooth Peripheral HIDS mouse example\n");
printk("Starting Bluetooth Peripheral HIDS mouse sample\n");

if (IS_ENABLED(CONFIG_BT_HIDS_SECURITY_ENABLED)) {
err = bt_conn_auth_cb_register(&conn_auth_callbacks);
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_hr_coded/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ int main(void)
uint32_t led_status = 0;
int err;

printk("Starting Bluetooth Peripheral HR coded example\n");
printk("Starting Bluetooth Peripheral HR coded sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_lbs/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ int main(void)
int blink_status = 0;
int err;

printk("Starting Bluetooth Peripheral LBS example\n");
printk("Starting Bluetooth Peripheral LBS sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_mds/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ int main(void)
uint32_t blink_status = 0;
int err;

printk("Starting Bluetooth Memfault example\n");
printk("Starting Bluetooth Memfault sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_nfc_pairing/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ int main(void)
{
int err;

printk("Starting Bluetooth NFC Pairing Reference example\n");
printk("Starting Bluetooth NFC Pairing Reference sample\n");

/* Configure LED-pins as outputs */
err = dk_leds_init();
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_power_profiling/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ int main(void)
uint32_t button_state = 0;
uint32_t has_changed = 0;

printk("Starting Bluetooth Power Profiling example\n");
printk("Starting Bluetooth Power Profiling sample\n");

err = dk_buttons_init(button_handler);
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_rscs/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ int main(void)
int err;
uint32_t blink_status = 0;

printk("Starting Running Speed and Cadence peripheral example\n");
printk("Starting Running Speed and Cadence peripheral sample\n");

err = dk_leds_init();
if (err) {
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_status/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ int main(void)
int blink_status = 0;
int err;

printk("Starting Bluetooth Peripheral Status example\n");
printk("Starting Bluetooth Peripheral Status sample\n");

err = dk_leds_init();
if (err) {
Expand Down
4 changes: 2 additions & 2 deletions samples/bluetooth/peripheral_uart/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ After programming the sample to your development kit, complete the following ste
#. Reset the kit.
#. Observe that **LED 1** is blinking and the device is advertising under the default name **Nordic_UART_Service**.
You can configure this name using the :kconfig:option:`CONFIG_BT_DEVICE_NAME` Kconfig option.
#. Observe that the text "Starting Nordic UART service example" is printed on the COM listener running on the computer.
#. Observe that the text "Starting Nordic UART service sample" is printed on the COM listener running on the computer.

.. group-tab:: nRF54 DKs

Expand All @@ -247,7 +247,7 @@ After programming the sample to your development kit, complete the following ste
#. Reset the kit.
#. Observe that **LED 0** is blinking and the device is advertising under the default name **Nordic_UART_Service**.
You can configure this name using the :kconfig:option:`CONFIG_BT_DEVICE_NAME` Kconfig option.
#. Observe that the text "Starting Nordic UART service example" is printed on the COM listener running on the computer.
#. Observe that the text "Starting Nordic UART service sample" is printed on the COM listener running on the computer.

.. _peripheral_uart_testing_mobile:

Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/peripheral_uart/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ static int uart_init(void)

if (tx) {
pos = snprintf(tx->data, sizeof(tx->data),
"Starting Nordic UART service example\r\n");
"Starting Nordic UART service sample\r\n");

if ((pos < 0) || (pos >= sizeof(tx->data))) {
k_free(rx);
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/rpc_host/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ You can take it as an example on how to create configuration for your own applic

Testing
=======
After programming the example build to your development kit, complete the following steps to test it:
After programming the sample build to your development kit, complete the following steps to test it:

1. Connect the dual core development kit to the computer using a USB cable.
The development kit is assigned a COM port (Windows) or ttyACM device (Linux), which is visible in the Device Manager.
Expand Down
Loading

0 comments on commit 188c9aa

Please sign in to comment.