Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nopnop2002/esp-idf-smb-client
SMB client example for esp-idf
https://github.com/nopnop2002/esp-idf-smb-client
esp-idf esp32 samba smb smbclient
Last synced: about 2 months ago
JSON representation
SMB client example for esp-idf
- Host: GitHub
- URL: https://github.com/nopnop2002/esp-idf-smb-client
- Owner: nopnop2002
- License: mit
- Created: 2021-05-25T07:41:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T00:43:28.000Z (12 months ago)
- Last Synced: 2024-10-11T13:44:47.668Z (2 months ago)
- Topics: esp-idf, esp32, samba, smb, smbclient
- Language: C
- Homepage:
- Size: 59.6 KB
- Stars: 21
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-idf-smb-client
SMB client example for esp-idf.
"SMB (Server Message Block)" is a standard file sharing protocol in Windows networks.
You can access Windows shared folder from esp32.
This project use [SMB2/3 userspace client](https://github.com/sahlberg/libsmb2).
# Software requirements
ESP-IDF V4.4/V5.x.
ESP-IDF V5.0 is required when using ESP32-C2.
ESP-IDF V5.1 is required when using ESP32-C6.
# Installation
```
git clone https://github.com/nopnop2002/esp-idf-smb-client
cd esp-idf-smb-client
git clone https://github.com/sahlberg/libsmb2 components/libsmb2
cd smb2-ls
idf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6}
idf.py menuconfig
idf.py flash
```
# Configuration
You have to set this config value with menuconfig.
- CONFIG_ESP_WIFI_SSID
SSID (network name) to connect to.
- CONFIG_ESP_WIFI_PASSWORD
WiFi password (WPA or WPA2) to use.
- CONFIG_ESP_MAXIMUM_RETRY
Set the Maximum retry to avoid station reconnecting to the AP unlimited when the AP is really inexistent.
- CONFIG_SMB_USER
Username with shared folder permissions.
- CONFIG_SMB_NEED_PASSWORD
Shared access requires password.
- CONFIG_SMB_PASSWORD
Password with shared folder permissions.
- CONFIG_SMB_HOST
IP address or mDNS host name of shared host.
- CONFIG_SMB_PATH
Shared path name.
When a password is required to access the shared folder.
Specify the SMB Host in one of the following formats.
- IP address like 192.168.10.120
- mDNS hostname like smbhost.local
# Examples
- smb2-ls
Shared directory file list
- smb2-cat
Read from a file in a shared directory
- smb2-put
Write to a file in a shared directory
- smb2-stat
Obtain file information in a shared directory
- smb2-mkdir
Create directory in a shared directory
# smbclient
You can check the services provided by the host using smbclient.
```
$ smbclient -L LANDISK-HDL-AA1.local -U admin
Enter WORKGROUP\admin's password:
Sharename Type Comment
--------- ---- -------
LAN DISK Log Disk HDL-AA Share for Log files
disk1 Disk HDL-AA RAID share
IPC$ IPC IPC Service (HDL-AA series)
SMB1 disabled -- no workgroup available
```