LDN

https://ldn.readthedocs.io/en/latest/
Admin
LDN is a Python package that implements the local wireless protocol used by the Nintendo Switch,...
Tokens:1,903
Snippets:12
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize MACAddress

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Examples of creating a MACAddress object from various input types.

```python
MACAddress() -> 00:00:00:00:00:00
```

```python
MACAddress("12:34:56:78:9a:bc") -> 12:34:56:78:9a:bc
```

```python
MACAddress(b"\x12\x34\x56\x78\x9a\xbc") -> 12:34:56:78:9a:bc
```

```python
MACAddress(0x123456789abc) -> 12:34:56:78:9a:bc
```

--------------------------------

### MACAddress String and Byte Representations

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Examples of string and byte representations returned by MACAddress methods.

```python
\x12\x34\x56\x78\x9a\xbc
```

```python
12:34:56:78:9a:bc
```

```python
MACAddress('12:34:56:78:9a:bc')
```

--------------------------------

### CreateNetworkParam

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Parameters required to create a new network instance.

```APIDOC
## CreateNetworkParam

### Description
Initializes a new instance for creating a network. 'local_communication_id', 'scene_id', 'name', 'app_version', and 'keys' are required.

### Request Body
- **ifname** (str) - Optional - Interface name for access point (default: "ldn").
- **ifname_monitor** (str) - Optional - Interface name for monitor (default: "ldn-mon").
- **ifname_tap** (str) - Optional - Name for TAP interface (default: "ldn-tap").
- **phyname** (str) - Optional - Wiphy name for access point (default: "phy0").
- **phyname_monitor** (str) - Optional - Wiphy name for monitor (default: "phy0").
- **local_communication_id** (int) - Required - Usually the title ID.
- **scene_id** (int) - Required - Game mode ID.
- **max_participants** (int) - Optional - Max participants (default: 8).
- **application_data** (bytes) - Optional - Game-specific data.
- **accept_policy** (int) - Optional - Station join policy (default: ACCEPT_ALL).
- **accept_filter** (list[MACAddress]) - Optional - Blacklist or whitelist.
- **security_level** (int) - Optional - Network security level (default: 1).
- **ssid** (bytes) - Optional - 16-byte SSID.
- **name** (bytes) - Required - User nickname.
- **app_version** (int) - Required - Application communication version.
- **platform** (int) - Optional - Platform constant (default: PLATFORM_NX).
- **channel** (int) - Optional - WLAN channel.
- **server_random** (bytes) - Optional - 16-byte random key.
- **password** (bytes) - Optional - Password/passphrase.
- **version** (int) - Optional - LDN version (default: 4).
- **enable_challenge** (bool) - Optional - DRM challenge status (default: True).
- **device_id** (int) - Optional - Device ID for DRM challenge.
- **protocol** (int) - Optional - Protocol to use (default: 1).
- **keys** (dict[str, bytes]) - Required - Encryption keys loaded from prod.keys.
- **override_advertise_key** (bytes) - Optional - Key to encrypt advertisement frames.
- **override_data_key** (bytes) - Optional - Key to encrypt data frames.
```

--------------------------------

### ConnectNetworkParam

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Parameters required to initialize a connection to an existing network.

```APIDOC
## ConnectNetworkParam

### Description
Initializes a new instance for connecting to a network. The 'network' and 'keys' fields are mandatory.

### Request Body
- **ifname** (str) - Optional - Interface name for the station (default: "ldn").
- **phyname** (str) - Optional - Name of the wiphy (default: "phy0").
- **network** (NetworkInfo) - Required - Network information obtained during scanning.
- **password** (bytes) - Optional - Password/passphrase for encryption keys (default: b"").
- **name** (bytes) - Required - User nickname (up to 32 bytes).
- **app_version** (int) - Required - Application communication version.
- **platform** (int) - Optional - Platform constant (default: PLATFORM_NX).
- **enable_challenge** (bool) - Optional - DRM challenge status (default: True).
- **device_id** (int) - Optional - Device ID for DRM challenge.
- **client_random** (bytes) - Optional - 16-byte random value for authentication.
- **keys** (dict[str, bytes]) - Required - Encryption keys loaded from prod.keys.
- **override_advertise_key** (bytes) - Optional - Key to decrypt advertisement frames.
- **override_data_key** (bytes) - Optional - Key to encrypt data frames.
```

--------------------------------

### Utility Functions

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Helper functions for managing encryption keys.

```APIDOC
## load_keys

### Description
Loads encryption keys from a prod.keys file.

### Parameters
#### Query Parameters
- **path** (str) - Required - Path to the prod.keys file.

### Response
- **dict[str, bytes]** - The loaded encryption keys.
```

--------------------------------

### STANetwork API

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Methods for interacting with the station network interface.

```APIDOC
## STANetwork

### Methods
- **info()** -> NetworkInfo: Returns information about the network.
- **participant()** -> ParticipantInfo: Returns information about the local participant.
- **broadcast_address()** -> str: Returns the broadcast address of the network.
- **next_event()** -> object: Waits until an event occurs (JoinEvent, LeaveEvent, DisconnectEvent, ApplicationDataChanged, or AcceptPolicyChanged).
```

--------------------------------

### Network Operations

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Functions for scanning, connecting to, and creating LDN networks.

```APIDOC
## scan

### Description
Searches for nearby LDN networks on the given WLAN channels.

### Parameters
#### Query Parameters
- **keys** (dict[str, bytes]) - Required - Encryption keys loaded from a prod.keys file.
- **ifname** (str) - Optional - Interface name (default: "ldn").
- **phyname** (str) - Optional - Physical interface name (default: "phy0").
- **channels** (list[int]) - Optional - List of channels to scan (default: [1, 6, 11]).
- **dwell_time** (float) - Optional - Time to dwell on each channel (default: .110).
- **protocols** (list[int]) - Optional - List of protocols (default: [1, 3]).

### Response
- **list[NetworkInfo]** - A list of discovered LDN networks.

---

## connect

### Description
Joins an active LDN network. The station is disconnected automatically at the end of the async with block.

### Parameters
#### Request Body
- **param** (ConnectNetworkParam) - Required - Parameters for joining the network.

### Response
- **STANetwork** - The active station network object.

---

## create_network

### Description
Creates a new LDN network. The network is destroyed automatically at the end of the async with block.

### Parameters
#### Request Body
- **param** (CreateNetworkParam) - Required - Parameters for network creation.

### Response
- **APNetwork** - The active access point network object.
```

--------------------------------

### APNetwork API

Source: https://ldn.readthedocs.io/en/latest/reference/ldn

Methods for interacting with the access point network interface.

```APIDOC
## APNetwork

### Methods
- **info()** -> NetworkInfo: Returns information about the network.
- **participant()** -> ParticipantInfo: Returns information about the local participant.
- **broadcast_address()** -> str: Returns the broadcast address of the network.
- **set_application_data(data: bytes)** -> None: Updates the application data.
- **set_accept_policy(policy: int)** -> None: Updates the station accept policy.
- **set_accept_filter(filter: list[MACAddress])** -> None: Updates the accept filter.
- **kick(index: int)** -> None: Kicks a station from the network.
- **next_event()** -> object: Waits until an event occurs (JoinEvent or LeaveEvent).
```
Tokens:
Raw