Sam is a Command Line Interface (CLI) tool created in order to easily setup and maintain Raspberry Pi and similar devices right from your computer, without having to create an SSH session and typing complex, low-level commands.
Sam is intented to be installed on your desktop computer or your laptop.
Here is the result of running
Commands:sam connect <HOSTNAME_OR_IP> Connect to a devicesam devices Discover devices on your local networksam disconnect Disconnect from a devicesam hass Home assistant commandssam init Install Snips Platform componentssam install Install assistant or skillssam login Login to the consolesam logout Logout of the consolesam mqtt Control MQTT servicesam reboot Reboot the devicesam service Display logs or restart Snips servicessam set-hostname <HOSTNAME> Set device hostnamesam setup Setup hardwaresam sound-feedback <toggle> Toogle sound feedback on or offsam status Show the status of your devicesam test Test microphone or speakersam update-assistant Update the assistant already installed on the devicesam update Update Snips platform on your devicesam watch Show MQTT logsOptions:--version Show version number [boolean]--help Show help [boolean]
List devices on the network whose Mac address matches that of a Raspberry Pi.
sam connect <HOSTNAME_OR_IP>
Establish an SSH connection to a device, saving the public key to the device in order to maintain the connection across sessions without requiring a password.
Disconnect Sam from the device, clearing the cached session info on the local machine.
Reboot the device that Sam is currently connected to. You will be shown a loading message until connection to the device is re-established.
Change device hostname. Then reboot it (
sam reboot) and wait until it comes back online.
Installs the Snips core components, including Snips Manager to execute apps.
Update the Snips Platform and its dependencies.
Watch for MQTT messages passed on the broker to which the device is connected.
sam sound-feedback <on|off>
Toggle sound feedback on or off.
Log in to the Snips Console. This will ask you for your credentials as provided on console.snips.ai, allowing you to install and update assistants directly from the command line.
Log out of the Snips Console.
sam install assistant
Install an assistant from the Console and the associated apps. Make sure you are logged in to the Console using
Fetch a newer version of the assistant present on the device.
sam install actions
Installs only the actions contained in the assistant.
sam service log [<SERVICE_NAME [, SERVICE_NAME...]>]
Show the logs of one or more services. If no service name is provided, all logs are shown.
sam start [<SERVICE_NAME [, SERVICE_NAME...]>]
Start one or more services. If no service name is provided, all services are started.
sam restart [<SERVICE_NAME [, SERVICE_NAME...]>]
Restart one or more services. If no service name is provided, all services are restarted.
sam stop [<SERVICE_NAME [, SERVICE_NAME...]>]
Stop one or more services. If no service name is provided, all services are stopped.
Fetch the device status, including the OS version, info about the installed assistant (name, wake word, language), and the status of all Snips services.
sam setup audio
Start a wizard to set up the audio input and output sources used by the Snips Platform.
sam setup aec
Audio echo cancellation (AEC) is meant to be used with the Maker Kit, which will improve wake word detection and automatic speech recognition performance when music is played on the device. It is a feature of PulseAudio. In order to activate it, Sam will therefore also install PulseAudio. This action can't be undone from Sam. However you can disable AEC and PulseAudio manually on your Pi.
sam test microphone
Starts recording audio on the device, and play it back after pressing Enter. Then plays back the sound, allowing you to test the quality of the audio capture.
sam test speaker
Play a sound on the speaker.
sam hass install
sam hass restart
Restart Home Assistant on the device.
sam hass configuration
Display the current
configuration.yaml of Home Assistant.
Please report issues or give feedback on the Snips Issue Tracker.