Add implementation for NativeSetDeviceName #3243

zandiarash · 2025-11-30T11:23:38Z

Description

Add implementation for NativeSetDeviceName().
Update declaration of System.Device.Wifi library.

Motivation and Context

Following Add API to set Wi-Fi adapter name System.Device.Wifi#322

I should mention that I am not familiar with C++ and after I changed nf-interpreter project I flashed my chip like this

nanoff --platform esp32 --target ESP32_REV3 --serialport COM6 --update  --clrfile "D:\Sources Electronic\Nanoframework - Copy\nf-interpreter\build\nanoCLR.bin"

How Has This Been Tested?

Screenshots

Before :

After :

Types of changes

Improvement (non-breaking change that improves a sample)
Bug fix (fixes an issue with a current sample)
New Sample (adds a new sample)
Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
Config and build (change in the configuration and build system, has no impact on code or features)
Documentation/comment (fixes and improvements documentation related)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Summary by CodeRabbit

New Features
- Added ability to set the device hostname via the WifiAdapter API for easier identification on Wi‑Fi networks.
Platform Notes
- Implemented on ESP32 targets (hostname applied to the network interface).
- On some RTOS and simulator targets this API is a stub/no‑op or returns not implemented; behavior varies by platform.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-11-30T11:23:52Z

Walkthrough

Adds a native WifiAdapter method to set the device hostname: header declaration, registration in the platform‑neutral native method table (an extra NULL slot and updated assembly CRC), an ESP32 implementation that sets the STA netif hostname, and AzureRTOS stubs (NOTIMPL/no‑op).

Changes

Cohort / File(s)	Summary
Native interface declaration `src/System.Device.Wifi/sys_dev_wifi_native.h`	Added `NativeSetDeviceName___VOID__STRING` declaration to `Library_sys_dev_wifi_native_System_Device_Wifi_WifiAdapter`.
Method registration & assembly identity `src/System.Device.Wifi/sys_dev_wifi_native.cpp`	Inserted `NativeSetDeviceName___VOID__STRING` into the public/native method table (placed before `NativeFindWirelessAdapters___STATIC__SZARRAY_U1`), added an extra NULL slot earlier in the table (shifting subsequent entries), and updated `g_CLR_AssemblyNative_System_Device_Wifi` CRC from `0x00A058C6` to `0x030E2768`; adjusted public data initializer count.
ESP32 platform implementation `targets/ESP32/_nanoCLR/.../sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp`	Added `#include <esp_netif.h>` and implemented `NativeSetDeviceName___VOID__STRING(CLR_RT_StackFrame&)`: read/validate hostname, resolve STA netif via `esp_netif_get_handle_from_ifkey("WIFI_STA_DEF")`, call `esp_netif_set_hostname`, map non-ESP_OK results to CLR errors; guarded by SOC/WIRELESS config macros.
AzureRTOS/ST platform implementation `targets/AzureRTOS/ST/_nanoCLR/.../sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp`	Added `NativeSetDeviceName___VOID__STRING(CLR_RT_StackFrame&)` returning `CLR_E_NOTIMPL`; removed `esp_wifi_types.h` include; added no-op `NativeInit___VOID`; minor whitespace/formatting edits.

Sequence Diagram(s)

sequenceDiagram
    participant Managed as Managed (C#)
    participant CLR as nanoCLR native entry
    participant ESP as esp_netif / ESP-IDF

    Managed->>CLR: Invoke NativeSetDeviceName(string hostname)
    CLR->>CLR: Read & validate hostname argument
    CLR->>CLR: (optional) validate network interface index
    CLR->>ESP: esp_netif_get_handle_from_ifkey("WIFI_STA_DEF")
    ESP-->>CLR: netif handle or NULL
    alt netif found
        CLR->>ESP: esp_netif_set_hostname(netif, hostname)
        ESP-->>CLR: esp_err_t (ESP_OK / error)
        CLR-->>Managed: return success or mapped CLR error
    else netif not found
        CLR-->>Managed: return CLR_E_INVALID_OPERATION (or mapped error)
    end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Verify ESP32 hostname handling: length, allowed characters, and error-to-CLR mappings.
Confirm config-guard macros (CONFIG_SOC_WIFI_SUPPORTED / CONFIG_SOC_WIRELESS_HOST_SUPPORTED) and build conditional paths.
Check consistency of the extra NULL slot and method table ordering across native tables and the updated assembly CRC/public data initializer.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly describes the main change: implementation of a new NativeSetDeviceName method across multiple files (native declarations and platform-specific implementations).

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b1720d and 0deede7.

📒 Files selected for processing (1)

src/System.Device.Wifi/sys_dev_wifi_native.cpp (2 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: josesimoes
Repo: nanoframework/nf-interpreter PR: 3243
File: targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp:31-50
Timestamp: 2025-12-02T09:32:22.318Z
Learning: In the nanoFramework WiFi implementation, hostname length validation for NativeSetDeviceName___VOID__STRING in targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp is performed at the caller level (managed code), not in the native implementation.

📚 Learning: 2025-12-02T09:32:22.318Z

Learnt from: josesimoes
Repo: nanoframework/nf-interpreter PR: 3243
File: targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp:31-50
Timestamp: 2025-12-02T09:32:22.318Z
Learning: In the nanoFramework WiFi implementation, hostname length validation for NativeSetDeviceName___VOID__STRING in targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp is performed at the caller level (managed code), not in the native implementation.

Applied to files:

src/System.Device.Wifi/sys_dev_wifi_native.cpp

📚 Learning: 2024-10-12T19:00:39.000Z

Learnt from: josesimoes
Repo: nanoframework/nf-interpreter PR: 3023
File: targets/netcore/nanoFramework.nanoCLR/nanoCLR_native.cpp:191-225
Timestamp: 2024-10-12T19:00:39.000Z
Learning: When working with `nanoCLR_GetNativeAssemblyInformation`, fixed-size assembly names are required, so code that deals with variable-length names cannot be used.

Applied to files:

src/System.Device.Wifi/sys_dev_wifi_native.cpp

🧬 Code graph analysis (1)

src/System.Device.Wifi/sys_dev_wifi_native.cpp (2)

targets/AzureRTOS/ST/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp (2)

NativeSetDeviceName___VOID__STRING (60-68)

NativeSetDeviceName___VOID__STRING (60-61)

targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp (2)

NativeSetDeviceName___VOID__STRING (25-61)

NativeSetDeviceName___VOID__STRING (25-26)

🔇 Additional comments (3)

src/System.Device.Wifi/sys_dev_wifi_native.cpp (3)

88-88: Metadata count increment is consistent with adding a new method.

The change from { 100, 0, 6, 4 } to { 100, 0, 6, 5 } reflects the addition of one new method to the assembly. This mechanical update should be automatically generated by the build tooling.

86-86: Assembly CRC update is correct.

The CRC change from 0x00A058C6 to 0x030E2768 correctly reflects the assembly structure modification in this version bump, along with the updated version tuple { 100, 0, 6, 5 }. The runtime uses this value to verify native/managed assembly compatibility.

36-43: Method table updates are correct and consistent with adding NativeSetDeviceName.

The method_lookup table properly adds the NativeSetDeviceName___VOID__STRING entry at line 43 with a corresponding NULL placeholder at line 44 (managed method slot without native implementation). The CRC and metadata count changes reflect this addition correctly.

The implementation is present in both ESP32 (full implementation) and AzureRTOS (stub). The method table ordering aligns with the implementation files.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f92554 and b7a2467.

📒 Files selected for processing (3)

src/System.Device.Wifi/sys_dev_wifi_native.cpp (2 hunks)
src/System.Device.Wifi/sys_dev_wifi_native.h (1 hunks)
targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2024-10-12T19:00:39.000Z

Learnt from: josesimoes
Repo: nanoframework/nf-interpreter PR: 3023
File: targets/netcore/nanoFramework.nanoCLR/nanoCLR_native.cpp:191-225
Timestamp: 2024-10-12T19:00:39.000Z
Learning: When working with `nanoCLR_GetNativeAssemblyInformation`, fixed-size assembly names are required, so code that deals with variable-length names cannot be used.

Applied to files:

src/System.Device.Wifi/sys_dev_wifi_native.h
src/System.Device.Wifi/sys_dev_wifi_native.cpp

📚 Learning: 2024-10-08T15:52:09.445Z

Learnt from: josesimoes
Repo: nanoframework/nf-interpreter PR: 3023
File: targets/netcore/nanoFramework.nanoCLR/nanoCLR_native.cpp:191-225
Timestamp: 2024-10-08T15:52:09.445Z
Learning: In `nanoCLR_GetNativeAssemblyInformation`, there is no need to return the number of bytes written, as the memory buffer is zeroed, making the string buffer terminated.

Applied to files:

src/System.Device.Wifi/sys_dev_wifi_native.h

🔇 Additional comments (3)

src/System.Device.Wifi/sys_dev_wifi_native.h (1)

69-69: LGTM! Method declaration follows the correct pattern.

The native method declaration is properly formatted and consistently placed with other WifiAdapter methods.

src/System.Device.Wifi/sys_dev_wifi_native.cpp (1)

36-43: LGTM! Method lookup table correctly updated.

The new method has been properly wired into the method lookup table. The CRC update at line 86 correctly reflects the assembly changes.

targets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp (1)

11-11: LGTM! Required include for ESP-NETIF APIs.

The esp_netif.h include is necessary for the hostname configuration functionality.

...ets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp

Ellerbach · 2025-12-01T10:02:43Z

@zandiarash please also use the proper PR template.

Ellerbach · 2025-12-01T10:04:32Z

Also, please adjust all the native devices. It's find to throw an exception but the build of other devices than ESP32 will break.

Ellerbach · 2025-12-01T10:32:42Z

/azp run

azure-pipelines · 2025-12-01T10:33:10Z

Azure Pipelines successfully started running 2 pipeline(s).

zandiarash · 2025-12-02T08:12:52Z

@zandiarash please also use the proper PR template.

Thank you for the guidance.
I’ve updated the pull request to use the proper template.

...reRTOS/ST/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp

...ets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp

...reRTOS/ST/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp

...ets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp

azure-pipelines · 2025-12-02T10:09:05Z

Azure Pipelines successfully started running 2 pipeline(s).

zandiarash · 2025-12-02T10:10:00Z

\azp run
To maintain a clean and linear commit history, should I make all commits as a single commit ?

josesimoes · 2025-12-02T10:53:24Z

\azp run
To maintain a clean and linear commit history, should I make all commits as a single commit ?

If you can do it, that's preferable.

zandiarash · 2025-12-02T11:07:56Z

\azp run
To maintain a clean and linear commit history, should I make all commits as a single commit ?

If you can do it, that's preferable.

@josesimoes I’ve already made everything into a single commit (your review messages and bot suggestions).👍

josesimoes · 2025-12-02T11:47:10Z

/azp run

azure-pipelines · 2025-12-02T11:47:38Z

Azure Pipelines successfully started running 2 pipeline(s).

...reRTOS/ST/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp

josesimoes

LGTM!

josesimoes · 2025-12-02T11:53:43Z

/azp run

azure-pipelines · 2025-12-02T11:54:10Z

Azure Pipelines successfully started running 2 pipeline(s).

zandiarash · 2025-12-09T11:11:54Z

@josesimoes @Ellerbach
May I kindly ask if there is anything pending on my side, or if there is any update regarding the merge process?
If there is anything further needed, I would be happy to do.

josesimoes · 2025-12-09T11:54:05Z

@zandiarash no further changes required. Waiting to complete other tasks and get to this one. Please hold.

josesimoes · 2025-12-16T17:58:07Z

/azp run

azure-pipelines · 2025-12-16T17:58:39Z

Azure Pipelines successfully started running 2 pipeline(s).

josesimoes · 2025-12-16T17:59:26Z

/azp run

azure-pipelines · 2025-12-16T17:59:52Z

Azure Pipelines successfully started running 2 pipeline(s).

nfbot · 2025-12-16T18:29:24Z

@zandiarash thank you again for your contribution! 🙏😄

.NET nanoFramework is all about community involvement, and no contribution is too small.
We would like to invite you to join the project's Contributors list.

Please edit it and add an entry with your GitHub username in the appropriate location (names are sorted alphabetically):

  <tr>
    <td><img src="https://github.com/zandiarash.png?size=50" height="50" width="50" ></td>
    <td><a href="https://github.com/zandiarash">Arash Zandi</a></td>
  </tr>

(Feel free to adjust your name if it's not correct)

zandiarash mentioned this pull request Nov 30, 2025

Wifi DeviceName has been added nanoframework/Samples#446

Open

11 tasks

coderabbitai bot reviewed Nov 30, 2025

View reviewed changes

...ets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp Outdated Show resolved Hide resolved

...ets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp Outdated Show resolved Hide resolved

zandiarash force-pushed the main branch from b7a2467 to c26eae9 Compare November 30, 2025 11:53

nfbot added the Type: enhancement label Dec 1, 2025

zandiarash mentioned this pull request Dec 1, 2025

Add API to set Wi-Fi adapter name nanoframework/System.Device.Wifi#322

Merged

11 tasks

zandiarash force-pushed the main branch 2 times, most recently from c26eae9 to b1deeab Compare December 1, 2025 17:13

zandiarash force-pushed the main branch from b1deeab to b3170cc Compare December 2, 2025 08:13

zandiarash commented Dec 2, 2025

View reviewed changes

...reRTOS/ST/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp Show resolved Hide resolved

josesimoes reviewed Dec 2, 2025

View reviewed changes

zandiarash force-pushed the main branch from b3170cc to e90b443 Compare December 2, 2025 09:33

nfbot added the Type: dependencies Pull requests that update a dependency file(s) or version label Dec 2, 2025

josesimoes added the Platform: ESP32 Everything related specifically with ESP32 platform label Dec 2, 2025

josesimoes reviewed Dec 2, 2025

View reviewed changes

...ets/ESP32/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp Outdated Show resolved Hide resolved

zandiarash force-pushed the main branch from b9f0edd to 738602c Compare December 2, 2025 09:51

josesimoes changed the title ~~Wifi DeviceName has been added~~ Add implementation for NativeSetDeviceName Dec 2, 2025

zandiarash force-pushed the main branch from 4785b5d to 6aa2d6e Compare December 2, 2025 11:04

josesimoes reviewed Dec 2, 2025

View reviewed changes

...reRTOS/ST/_nanoCLR/System.Device.Wifi/sys_dev_wifi_native_System_Device_Wifi_WifiAdapter.cpp Outdated Show resolved Hide resolved

zandiarash force-pushed the main branch from 6aa2d6e to 38cdefa Compare December 2, 2025 11:50

josesimoes approved these changes Dec 2, 2025

View reviewed changes

Wifi DeviceName added

7b1720d

josesimoes force-pushed the main branch from 38cdefa to 7b1720d Compare December 16, 2025 17:49

josesimoes enabled auto-merge (squash) December 16, 2025 17:50

Bump native assembly version

0deede7

josesimoes merged commit 5a6d06d into nanoframework:main Dec 16, 2025
27 checks passed

Uh oh!

Add implementation for NativeSetDeviceName #3243

Add implementation for NativeSetDeviceName #3243

Uh oh!

Conversation

zandiarash commented Nov 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

Checklist:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Ellerbach commented Dec 1, 2025

Uh oh!

Ellerbach commented Dec 1, 2025

Uh oh!

Ellerbach commented Dec 1, 2025

Uh oh!

azure-pipelines bot commented Dec 1, 2025

Uh oh!

zandiarash commented Dec 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

azure-pipelines bot commented Dec 2, 2025

Uh oh!

zandiarash commented Dec 2, 2025

Uh oh!

josesimoes commented Dec 2, 2025

Uh oh!

zandiarash commented Dec 2, 2025

Uh oh!

josesimoes commented Dec 2, 2025

Uh oh!

azure-pipelines bot commented Dec 2, 2025

Uh oh!

Uh oh!

josesimoes left a comment

Choose a reason for hiding this comment

Uh oh!

josesimoes commented Dec 2, 2025

Uh oh!

azure-pipelines bot commented Dec 2, 2025

Uh oh!

zandiarash commented Dec 9, 2025

Uh oh!

josesimoes commented Dec 9, 2025

Uh oh!

josesimoes commented Dec 16, 2025

Uh oh!

azure-pipelines bot commented Dec 16, 2025

Uh oh!

josesimoes commented Dec 16, 2025

Uh oh!

azure-pipelines bot commented Dec 16, 2025

Uh oh!

Uh oh!

nfbot commented Dec 16, 2025

zandiarash commented Nov 30, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 30, 2025 •

edited

Loading