Creating Module

This page describes how to configure communication modules in SIWENOID v2. Modules are the components that enable SIWENOID v2 to send outgoing notifications — such as SMS messages and emails — in response to events. Modules are created once and then referenced by Tasks (see the Creating Tasks page) which define when and to whom notifications are sent.

A module in SIWENOID v2 is a configured communication channel that the server can use to send outgoing messages. Each module defines the technical connection parameters for one specific communication method. The two supported outgoing notification module types are:

• SMS module — sends text messages via a GSM modem or USB SIM card device connected to the SIWENOID v2 server machine. Requires a physical GSM hardware device with a SIM card.
• Email module — sends email notifications via an SMTP mail server. Requires network access from the SIWENOID v2 server to the configured SMTP server.

Multiple modules of the same type can be created — for example, two SMS modules using different SIM cards for redundancy, or two email modules using different sender accounts for different notification types.

Modules themselves do not define when messages are sent or to whom. That configuration is done in Tasks. A module is purely the technical sending channel.

Prev ← Creating Categories Next → Everyday Operation of SIWENOID v2

To access the Modules configuration, navigate to File → Preferences → Modules.

The Modules screen lists all currently configured modules. Click the Add button (plus icon) to create a new module. Enter a name for the module and select the module type (SMS or Email) from the type dropdown. The configuration fields that appear depend on the selected type.

The SMS module enables SIWENOID v2 to send text messages using a USB GSM modem or a USB device containing a SIM card connected to the server machine.

Before configuring the SMS module, the Vendor ID (VID) and Product ID (PID) of the USB GSM device must be identified. These values uniquely identify the USB hardware to SIWENOID v2 and are required for the software to communicate with the device.

To find the VID and PID on Windows:

1. Connect the USB GSM device to the server machine.
2. Open Windows Device Manager (right-click the Start button and select Device Manager, or run devmgmt.msc).
3. Locate the GSM device in the device list. It typically appears under “Ports (COM & LPT)” or “Modems”.
4. Double-click the device to open its properties window.

1. Select the Details tab in the properties window.
2. In the Property dropdown, select Hardware IDs.

The Hardware IDs value contains the VID and PID in the format: USB\VID_XXXX&PID_XXXX

• The four characters after VID_ are the Vendor ID (for example: 067B).
• The four characters after PID_ are the Product ID (for example: 2303).

Note these values before proceeding to the module configuration.

In the SMS module editor, fill in the following fields:

Name A descriptive name for this SMS module, used to identify it when assigning it to a Task. Example: “GSM modem 1” or “SMS notification channel”.

PIN code The PIN code of the SIM card installed in the USB GSM device. If the SIM card does not have a PIN code set, leave this field empty. Entering an incorrect PIN code will cause the SIM card to lock after three failed attempts — verify the PIN code before saving.

VID (Vendor ID) Enter the Vendor ID value found in Step 1 (for example: 067B).

PID (Product ID) Enter the Product ID value found in Step 1 (for example: 2303).

After filling in all fields, click Save. SIWENOID v2 will attempt to initialise communication with the GSM device using the configured VID/PID. Verify that the module status shows as connected or ready after saving.

The SMS module is now available for selection when configuring Tasks. Recipient phone numbers are configured in the Task definition, not in the module itself.

The email module enables SIWENOID v2 to send email notifications via an SMTP mail server.

Fill in the following fields:

Name A descriptive name for this email module. Example: “Security notifications email” or “SMTP outbound”.

Username The username for authenticating with the SMTP server. For most email providers this is the full email address of the sender account (for example: siwenoid.alerts@yourdomain.com).

Sender address The email address that will appear in the “From” field of all outgoing notifications. This is typically the same as the username.

Password The password for the sender email account used to authenticate with the SMTP server.

Host The SMTP server address of the email provider. Examples:

• Office 365: smtp.office365.com
• Custom mail server: mail.yourdomain.com

Port The TCP port used by the SMTP server. Common values:

• 587 — SMTP with STARTTLS encryption (recommended for most providers)
• 465 — SMTP over SSL/TLS
• 25 — unencrypted SMTP (not recommended, blocked by many providers)

Consult your email provider's documentation for the correct host and port values.

Google has removed the “Allow less secure apps” option that was previously required for direct SMTP access to Gmail accounts. Gmail can no longer be used directly as an SMTP sender with a standard username and password in this configuration.

If a Gmail account must be used, the following alternatives are available:

• Configure an App Password in the Google account (requires 2-Step Verification to be enabled on the account) and use the App Password in the Password field instead of the regular account password.
• Use a Google Workspace account with SMTP relay configured by the Workspace administrator.
• Use a different email provider or a dedicated notification email account on a domain mail server.

For new installations, it is recommended to use a dedicated email account on a corporate mail server or a professional SMTP relay service rather than a personal Gmail account.

After filling in all fields, click Save. The email module is now available for selection when configuring Tasks. Recipient email addresses are configured in the Task definition, not in the module itself.

• Modules are server-side components managed by the SIWENOID v2 server process. They function independently of whether any client is connected.
• The USB GSM device for the SMS module must be connected to the physical machine running the SIWENOID v2 server. It cannot be on a remote machine or connected via a network.
• If the GSM device is disconnected or the SIM card loses signal, SMS sending will fail. Task execution failures are recorded in the SIWENOID v2 event log.
• Module configurations are stored in the SIWENOID v2 database and are included in database backups.
• After creating or modifying a module, test it by manually triggering a test event that uses that module in a Task, and verify that the SMS or email is received correctly.

—

Prev ← Creating Categories Next → Everyday Operation of SIWENOID v2