The WCM can be easily customized to work for your specific product.
WCM Configuration Parameters
The WCM configuration is read at runtime from the file wcm_agent.conf, which is located in the directory in which the WCM is installed. The file includes the following parameters:
Storage Settings
| Parameter | Description | Default value |
|---|---|---|
| Persistent Storage Directory | Where the WCM and related files that need to be persisted are installed | /etc/ |
| Volatile Storage Directory | Where the WCM writes volatile or temporary files (e.g. log files) | /tmp/ |
| Log Storage Type | Whether the log files are written to volatile or persistent storage | Volatile |
Basic Settings
| Parameter | Description | Default value |
|---|---|---|
| WiFi Interface | The network interface to use for client access | wlan0 |
| CA Cert Location | Where WCM reads or writes SSL certs | /etc/ssl/certs/ca-certificates.crt |
| Max Log Space | How much space is reserved for log files | 100 KB |
| Timing Profile | Timeout/retry intervals | Powered |
| CheckURL | The URL to check for internet connectivity | https://dev.cirrentsystems.com |
| Temporary Credentials | Whether the WCM starts with temporary or permanent credentials | Disabled |
| User Binding | Whether the mobile app handles user-device binding; set to No if the mobile app does not handle user-device binding (and therefore the product needs the WCM to force device-only binding instead). | Yes |
| Onboarding button | Whether the device has a button that the user must press for softAP to come up. | No |
| BSSID disambiguation | Whether the underlying WiFi driver/chip is able to handle requests to connect with a specific BSSID - if set to Yes, the WCM will allow the driver to choose the BSSID and adapt its connection algorithm accordingly (it is preferable and more efficient to set to No to allow the WCM to choose the best BSSID if the driver allows this behavior). | No |
| Default mode | Whether the WCM actively manages the configured wireless network interface - this is the standard mode for a connected product; if set to Unmanaged, the WCM does not manage the wireless network interface (instead, the system is expected to control the interface) - this is the typical setting for an extender or Ethernet-capable device with an active wired connection. | Managed |
| Network Filtering | By default the WCM uses iptables to protect the connected product by filtering unexpected traffic (e.g. over SoftAP) - it is recommended to support iptables; however, if it is not feasible to support iptables on the product, this traffic filtering can be disabled by setting this value to None. | iptables |
WCM Modules
| Parameter | Description | Default value |
|---|---|---|
| SoftAP | Whether SoftAP is enabled or disabled | Enabled |
| ZipKey Hotspot | Whether WCM supports a ZipKey hotspot for other WCM devices to use | Disabled |
| Bluetooth | Whether BLE is enabled or disabled (WCM 1.2 and above) | Disabled |
AP Mode Settings
| Parameter | Description | Default value |
|---|---|---|
| AP Shared Radio | Whether the same radio is used for client and AP, or whether the AP and Station modes need to be on the same channel. | No |
| AP WiFi Interface | The network interface to use for the AP (if not a shared radio) | wlan1 |
SoftAP Settings
| Parameter | Description | Default value |
|---|---|---|
| SoftAP Network SSID | The SSID being broadcast by SoftAP. The $$$$DUB$$$$ string placeholder could be used inside the SSID to generate a unique SSID for each device though it should be noted that iOS 11 does not support wildcard SSIDs for softAP. | wcm-softap |
| SoftAP Network Channel | The channel on which the SoftAP SSID is broadcast | 1 |
| HTTP Server Address | The IP address on which the SoftAP HTTP server is listening | 192.168.211.1 |
| HTTP Server Port | The port on which the SoftAP HTTP server is listening | 80 |
| Auto SoftAP | By default the WCM automatically brings up the SoftAP interface on boot (until the device has been provisioned) - this minimizes friction for the user (no need for a button press to start SoftAP); however, if a product needs this feature disabled, this value should be set to No. | Yes |
BT Settings
| Parameter | Description | Default value |
|---|---|---|
| BLE Short Name | The device name that will be broadcast over the BLE network. You can include the macro $$$DUB$$$ if you want each device to broadcast a different name (e.g. WCM_$$$DUB$$$). The BLE Short Name must start with a fixed string so that the mobile app can detect and connect to the BLE network. | WCM_BLE |
Comments
0 comments
Please sign in to leave a comment.