Skip to content
pschatzmannPublic

About

Header-only C++ SMB File Sharing Library for Microcontrollers

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

14 Commits

Folders and files

Repository files navigation

Tiny Server Message Block (SMB) File Sharing Library

Arduino Library Doxygen Build: CMake License: MIT

SMB (Server Message Block) is the network file sharing protocol of Windows. It is also supported by macOS, Linux, Android and iOS. A share appears as a network drive or folder, and clients can browse, open, copy, rename and delete the files on it.

This header-only C++ library provides an SMB2 server and an SMB2 client for Arduino. Both use only the Arduino networking API (Server/Client), so they work with WiFiServer/WiFiClient, EthernetServer/EthernetClient and others. The main target is the ESP32.

Component What it does Documentation
SMBServer Shares an SD card (SD or SD_MMC), flash file system or directory with Windows, macOS and Linux Server
SMBClient Reads and writes the files on a Windows, macOS or Samba share; on the ESP32 also as fs::FS (SMBFS) Client

Both implement the SMB 2.0.2 and 2.1 dialects with NTLMv2 authentication and message signing.

Documentation

The documentation is in the Wiki; the class reference is generated with Doxygen: API documentation.

  • Server: features, file systems and an example.
  • Client: API, ESP32 fs::FS integration, configuration and an example.
  • Usage Notes: supported protocol features, security, performance and memory. Read this before using the library.
  • Running on the Desktop: CMake build with the Arduino Emulator, desktop examples and tests.
  • Testing Status: what is tested, open tests and how to report results.

Logging

Both the server and the client use a minimal, shared logger: a ready-to-use static instance smb::SMBLogger of class smb::SMBLoggerClass, writing to any Arduino Print destination (e.g. Serial). Logging is disabled by default; call begin() once to activate it:

#include "SMB.h"

void setup() {
  Serial.begin(115200);
  smb::SMBLogger.begin(Serial, smb::SMBLogLevel::Info);
  // ...
}

Available log levels (smb::SMBLogLevel), from least to most verbose:

  • None – logging disabled (default)
  • Error – only errors
  • Info – errors and informational messages
  • Debug – errors, info and detailed protocol/debug messages

Internally, the library logs with the SMB_LOGE, SMB_LOGI and SMB_LOGD macros, which are no-ops when the corresponding level is not active, so leaving logging off (or at Error) has negligible overhead. See Server Configuration for more on server-side logging configuration.

Installation

For Arduino, you can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with

cd  ~/Documents/Arduino/libraries
git clone https://github.com/pschatzmann/arduino-smb.git

The library is header-only and has no dependencies besides the Arduino core. Include SMB.h, or SMB_SD.h / SMB_SDMMC.h to share an SD card.

About

Header-only C++ SMB File Sharing Library for Microcontrollers

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages

⌂ 换网址