Connecting to SMB File Sharing#

This guide will walk you through how to connect Artificial to SMB File Sharing using the SMB Resource Library.

Attention

Before you get started, make sure your local Adapter development environment is set up and ready to go.

Install the Resource Library in your Adapter#

Run the following command in the terminal of your adapter repository to install Artificial’s SMB Resource Library:

uv add artificial-smb-resource-library==0.0.*

Your pyproject.toml file should now include artificial-smb-resource-library in the project dependencies section:

[project]
dependencies = [
  ...
  "artificial-smb-resource-library==0.0.*",
]

Update your Adapter Config#

config.yaml#
adapter:
  name: SmbTutorialAdapter
  remoteConfig: True
  allowAnySequenceId: True # Useful when running in a local dev container

Note

When you configure the adapter in LabOps, enter the ip address as just the server name or ip address, no http:// needed. Also, fill in the username and password.

Use the Resource Library in your Adapter#

adapter/main/plugin.py file#
from artificial.adapter_common import ActionModulePlugin, action_modules
from artificial.adapter_common.plugin import PluginContext, plugin_config
from artificial.logging import get_logger
from artificial.smb.actions import SMBActions
from artificial.smb.config.config import SMBConfig

logger = get_logger(__name__)

@action_modules(SMBActions)
class AdapterPlugin(ActionModulePlugin):
    cfg = plugin_config(SMBConfig)

    async def setup(self, pctx: PluginContext) -> None:
        self.add_module(SMBActions(self.cfg))

Add the required Actors#

Add the following actors to the list of actors in adapter/main/__main__.py.

adapter/main/__main__.py#
actors = [
    ActorConfig(id='smb', abilities={'smb': 1}),
]

Publish and run a test Workflow#

This workflow will get the list of files at the given path and display that in Artificial. For path enter only the shared file path, no server name needed, e.g. smb\test.

from artificial.workflows.decorators import parameter, workflow
from artificial.workflows.runtime import show_info
from stubs.stubs_actions import get_files


@parameter('smb_folder_path', {'required': True, 'uiTitle': 'Folder Path'})
@workflow('Simple SMB Test Workflow', 'simple_smb_workflow')
async def simple_smb_workflow(smb_folder_path: str) -> None:
    files = await get_files(smb_folder_path=smb_folder_path)
    filestring = 'The files at that path are: '
    for file in files:
        filestring += file + ', '
    await show_info(filestring)
    await show_info('Congratulations, you successfully ran the SMB workflow!', 'Hardware Success')

Full SMB API#

class SMBConfig(smbuser: str, smbpass: str, ipaddress: str)#
ipaddress: str#
smbpass: str#
smbuser: str#
classmethod testing(**kwargs: Any) → SMBConfig#

Uninitialized config for testing purposes

class SMBActions(cfg: SMBConfig)#
async async_io_custom_executor(
function: Callable,
*args: Any,
**kwargs: Any,
) → Any#
async create_directory(
actx: ActionExecutionContext,
smb_folder_path: str,
) → str#
async get_files(
_: ActionExecutionContext,
smb_folder_path: str,
) → List[str]#
async path_exists(
actx: ActionExecutionContext,
smb_folder_path: str,
) → bool#
async read_file(
actx: ActionExecutionContext,
smb_folder_path: str,
file_name: str,
) → bytes#
async write_file(
actx: ActionExecutionContext,
smb_folder_path: str,
file_name: str,
contents: str | bytes,
) → None#
async write_request_input_file(
actx: ActionExecutionContext,
smb_folder_path: str,
file_name: str,
contents_b64: str,
) → None#