Skip to main content

HotspotConfig

Struct HotspotConfig 

Source
pub struct HotspotConfig {
    pub ssid: String,
    pub password: Option<String>,
    pub interface: String,
    pub band: HotspotBand,
    pub channel: u8,
}
Expand description

Configuration for creating a WiFi hotspot.

Use the builder pattern to configure hotspot settings before passing to WifiManager::start_hotspot_with_config().

§Example

use rpi_host::{WifiManager, HotspotConfig, HotspotBand};

let wifi = WifiManager::new()?;

// Basic configuration
let config = HotspotConfig::new("MyHotspot")
    .with_password("password123");

// Advanced configuration
let config = HotspotConfig::new("My5GHotspot")
    .with_password("securepass")
    .with_band(HotspotBand::A)
    .with_channel(36);

wifi.start_hotspot_with_config(config)?;

Fields§

§ssid: String

The SSID (name) for the hotspot.

§password: Option<String>

Optional password for the hotspot.

If None, creates an open network. If Some, must be at least 8 characters.

§interface: String

The wireless interface to use.

Defaults to “wlan0”.

§band: HotspotBand

WiFi frequency band to use.

Defaults to 2.4GHz (HotspotBand::Bg) for maximum compatibility.

§channel: u8

WiFi channel to use.

Set to 0 for automatic channel selection.

Implementations§

Source§

impl HotspotConfig

Source

pub fn new(ssid: impl Into<String>) -> Self

Create a new hotspot configuration with the given SSID.

Uses default values:

  • No password (open network)
  • Interface: wlan0
  • Band: 2.4GHz
  • Channel: auto
Source

pub fn with_password(self, password: impl Into<String>) -> Self

Set the hotspot password (must be at least 8 characters).

Source

pub fn with_interface(self, interface: impl Into<String>) -> Self

Set the wireless interface to use.

Source

pub fn with_band(self, band: HotspotBand) -> Self

Set the frequency band.

Use HotspotBand::Bg (2.4GHz) for maximum device compatibility, or HotspotBand::A (5GHz) for faster speeds with compatible devices.

Source

pub fn with_channel(self, channel: u8) -> Self

Set the WiFi channel.

For 2.4GHz, valid channels are typically 1-11 (varies by region). For 5GHz, common channels include 36, 40, 44, 48, 149, 153, 157, 161. Set to 0 for automatic selection.

Trait Implementations§

Source§

impl Clone for HotspotConfig

Source§

fn clone(&self) -> HotspotConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for HotspotConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.