Skip to content

Configuration

akadlec edited this page Jan 7, 2024 · 1 revision

Configuration

To use Virtual devices with the FastyBird IoT ecosystem, you will need to configure at least one connector. The connector can be configured using the FastyBird IoT user interface or through the console.

Configuring the Connectors and Devices through the Console

To configure the connector through the console, run the following command:

php bin/fb-console fb:virtual-connector:install

Note

The path to the console command may vary depending on your FastyBird application distribution. For more information, refer to the FastyBird documentation.

This command is interactive and easy to operate.

The console will show you basic menu. To navigate in menu you could write value displayed in square brackets or you could use arrows to select one of the options:

Virtual connector - installer
=============================

 ! [NOTE] This action will create|update|delete connector configuration

 What would you like to do? [Nothing]:
  [0] Create connector
  [1] Edit connector
  [2] Delete connector
  [3] Manage connector
  [4] List connectors
  [5] Nothing
 > 0

Create connector

If you choose to create a new connector, you will be asked to provide a connector identifier and name:

 Provide connector identifier:
 > my-virtual
 Provide connector name:
 > My Virtual

After providing the necessary information, your new Virtual connector will be ready for use.

 [OK] New connector "My Virtual" was successfully created

Create device

After new connector is created you will be asked if you want to create new device:

 Would you like to configure connector device(s)? (yes/no) [yes]:
 > 

Or you could choose to manage connector devices from the main menu.

Connectors and Devices management

With this console command you could manage all your connectors and their devices. Just use the main menu to navigate to proper action.

Configuring the Connector with the FastyBird User Interface

You can also configure the Virtual connector using the FastyBird IoT user interface. For more information on how to do this, please refer to the FastyBird IoT documentation.