Adding video commands

Prerequisites

The device meets the requirements for video functionality.

Service providers can configure commands to request video streams, video clips, or photos from devices. These commands are sent to the device tracking unit. Before users can access these commands, service providers must first create command templates and then make them available in the FleetSpace interface through widgets.

Part 1: Creating a command template

Who can do it: Service provider
Where: Wialon Platform Studio

Command templates are reusable configurations that allow you to define a command once and apply it to many different devices. They’re especially useful for managing mixed fleets, as a single template can contain the same command for different device models, simplifying configuration in the user interface.

To create a template with video commands, follow these steps:

  1. Create a command template following the guide on the Creating command templates page.

  2. On the Commands tab, select the device model and click the icon plus icon.

  3. Select the command based on the required action. For example, depending on the specific device, the following commands can be available:

    • Take photo: Requests a photo from a selected camera channel at the moment the command is executed.
    • Start video stream: Starts a live stream from a selected camera channel.
    • Request video: Downloads a video clip for a specified time and duration from a selected camera channel.
    • Playback video: Streams previously recorded video with playback controls.
  4. Configure the default parameter values for the command. These values are pre-filled when a user executes the command. You can leave them empty, and then users set them manually. The following parameters are the most common ones:

    Parameter Description
    channel The camera number. Each camera of the device has its own channel number. See the device manufacturer documentation to find out which number corresponds to which camera.
    from The start time of the requested video.
    duration The length of the requested video.

  5. If you have different device models with video functionality, add a command for other devices to the same template repeating steps 2-4. One command template can contain similar commands for different types of devices, for example, the Request video commands with their own settings for Howen and Streamax devices.

  6. Click Save to create the command template.

Part 2: Configuring widgets for commands

Who can do it: Service provider
Where: Wialon Platform FleetSpace

You can configure the appropriate widgets in FleetSpace to make these commands accessible for users. You can add command widgets to either the device list or device details page.

  1. Log in to Wialon Platform FleetSpace as the customer.
  2. Go to the Devices page. If you want to add widgets in the device details, click on any device to open its details.
  3. Make sure the required workspace is selected. If you need to create a new workspace, see the guide on creating a new workspace.
  4. Click the icon in the sidebar to enable the editor mode.
  5. Click the icon three dots or plus icon in the top right corner of a device row. This opens the Device list entry: actions window.
  6. Select the Execute command widget.
  7. Select the previously configured command template and choose an icon for it.
  8. Click the icon floppy disk icon.
  9. Repeat steps 5-8 if you need to add more command widgets.
  10. Click Save to apply the configuration.

Also, add a separate widget so that users can view the results of the command execution. For example, if you add the Request video command, users need the Media widget to view downloaded videos. See Configuring video widgets for instructions.

Part 3: Granting permissions to a customer user

Who can do it: Service provider
Where: Wialon Platform Studio

After configuring a command template, you must grant the customer user permission to access it.

  1. Log in to Wialon Platform Studio.
  2. Navigate to the Customers page from the main menu.
  3. Select the required customer from the list.
  4. Go to the Users tab within the customer’s details.
  5. Click on the user’s row to open their details and go to the Permissions tab.
  6. Click on the Devices page.
  7. Make sure that the Send commands permission is selected.
  8. Click Save to apply any changes to the user’s permissions.

After this setup, ensure the customer user has the necessary permissions to use the workspace where you’ve added the command widgets.

Now the customer user can request video and pictures using commands.

If you find a mistake in the text, please select it and press Ctrl+Enter.