The Cirrent Agent(CA) can be easily customized to work for your specific product.
Cirrent Agent Configuration Parameters
The Cirrent Agent configuration is read at runtime from the file cirrent_agent.conf, which is located in the directory in which the Cirrent Agent is installed (default /etc/cirrent). Reference cirrent_agent.conf file could be found in cirrent_agent/linux/config directory. The file includes the following parameters: (Note some of these parameters are only required to support the IoT Network Intelligence (INI) functionality.
Storage Settings
|
Parameter |
Description |
Default value |
Req'd for INI |
|
Persistent Storage Directory |
Where the Cirrent Agent and related files that need to be persisted are installed |
/etc/ |
|
|
Volatile Storage Directory |
Where the Cirrent Agent writes volatile or temporary files (e.g. log files) |
/tmp/ |
|
|
Log Storage Type |
Whether the log files are written to volatile or persistent storage |
Persistent |
|
|
Log Storage Threshold |
What percent of free space must be crossed to stop writing logs |
7 |
|
Basic Settings
|
Parameter |
Description |
Default value |
Req'd for INI |
|
WiFi Interface |
The network interface to use for client access |
wlan0 |
|
|
Max Log Space |
How much space is reserved for log files |
100 KB |
|
|
CheckURL |
The URL to check for internet connectivity |
https://dev.cirrentsystems.com “Success” http://captive.apple.com/hotspot-detect.html “<HTML><HEAD><TITLE>Success</TITLE></HEAD><BODY>Success</BODY></HTML>\n” http://www.google.com/blank.html “” |
|
|
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 Cirrent Agent 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 Cirrent Agent to choose the best BSSID if the driver allows this behavior). |
No |
|
|
Default mode |
Whether the Cirrent Agent actively manages the configured wireless network interface - this is the standard mode for a connected product; if set to Unmanaged, the Cirrent Agent 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 Cirrent Agent 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 |
|
|
DHCP Client args |
String that will be passed as argument for dhcp client (udhcpc) |
Cirrent Agent Modules
|
Parameter |
Description |
Default value |
|
ZipKey |
Whether ZipKey functionality is enabled or disabled |
Enabled |
|
SoftAP |
Whether SoftAP is enabled or disabled |
Enabled |
|
Bluetooth |
Whether BLE is enabled or disabled |
Enabled |
ZipKey Settings
|
Parameter |
Description |
Default value |
|
CA Cert Location |
Where Cirrent Agent reads or writes SSL certs. If not specified the system default will be used for establishing HTTPS connection with the Cirrent Cloud but automatic certificates update will be unavailable |
/etc/cirrent/certs/ca-certificates.crt |
|
Temporary Credentials |
Whether the Cirrent Agent starts with temporary or permanent credentials |
Disabled |
|
ZipKey Hotspot |
Whether Cirrent Agent supports a ZipKey hotspot for other ZipKey-enabled devices to use |
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 Cirrent Agent to force device-only binding instead). |
Yes |
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. |
ca-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 Cirrent Agent 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. CA_$$$DUB$$$). The BLE Short Name must start with a fixed string so that the mobile app can detect and connect to the BLE network. |
CA_BLE |
Comments
0 comments
Please sign in to leave a comment.