Commands -- Cellular & Carrier

POST `/api/cmd.billing.newCycle`

Start a new billing cycle by Connection ID and SIM ID.

Available in 8.1.0 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN Connection ID to renew billing cycle
`simId`	`number`	optional	`1` for SIM A, `2` for SIM B. Always send `1` for single SIM models. Ignored if WAN does not support cellular.

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"connId":4,"simId":1}' \
  http://192.168.1.1/api/cmd.billing.newCycle

{
  "stat": "ok"
}

GET `/api/cmd.carrier.scan`

Obtain the result of discovered cellular network.

Returns fail when the WAN connection does not support carrier scan.

Available in 8.0.1 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN connection ID to scan
`reference`	`string`	✅	`yes` or `no` -- include current configuration reference

Response

Field	Type	Description
`scanStatus`	`string`	`scanning` or `done`
`timestamp`	`integer`	Timestamp of the carrier list
`list`	`array`	List of `Scan_Carrier` objects
`reference`	`object`	Current configuration (`Reference` object)

Scan_Carrier Object:

Field	Type	Description
`name`	`string`	Name of the carrier
`mobileType`	`string`	`2G`, `3G`, or `LTE`
`mcc`	`string`	Mobile Country Code (3 digits)
`mnc`	`string`	Mobile Network Code (2--3 digits)
`pcs`	`number`	`0` or `1`

Reference Object:

Field	Type	Description
`activeSim`	`object` or `null`	Active SIM info (`In_Use_SIM` object), or `null` if no active SIM

In_Use_SIM Object:

Field	Type	Description
`simId`	`number`	`1` or `2`
`selectedCarrier`	`object` or `null`	Selected carrier (`Carrier` object), or `null` if auto

Carrier Object:

Field	Type	Description
`name`	`string`	Name of the carrier
`mcc`	`string`	Mobile Country Code (3 digits)
`mnc`	`string`	Mobile Network Code (2--3 digits)
`pcs`	`number`	`0` or `1`

cURL Example

curl -b cookies.txt \
  "http://192.168.1.1/api/cmd.carrier.scan?connId=4&reference=yes"

{
  "stat": "ok",
  "response": {
    "scanStatus": "scanning",
    "list": [
      {
        "name": ".csl",
        "mobileType": "LTE",
        "mcc": "454",
        "mnc": "0",
        "pcs": 0
      },
      {
        "name": "SMT HK",
        "mobileType": "LTE",
        "mcc": "454",
        "mnc": "6",
        "pcs": 0
      }
    ],
    "reference": {
      "activeSim": {
        "simId": 1,
        "cellularNetwork": null
      }
    }
  }
}

POST `/api/cmd.carrier.scan`

Trigger and obtain the result of discovered cellular network.

Returns fail when the WAN connection does not support carrier scan.

Available in 8.1.0 or later

Input Parameters

Field	Type	Required	Description
`action`	`string`	optional	`start` to trigger scan
`connId`	`number`	✅	WAN connection ID to scan
`reference`	`string`	optional	`yes` or `no`

Response

Same as GET /api/cmd.carrier.scan.

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"action":"start","connId":"4","reference":"yes"}' \
  http://192.168.1.1/api/cmd.carrier.scan

POST `/api/cmd.carrier.select`

Update the cellular network selection.

Available in 8.0.1 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN connection ID
`simId`	`number`	optional	`1` or `2` -- SIM to change carrier selection
`selectedCarrier`	`object`	✅	Carrier to select

Carrier Object:

Field	Type	Required	Description
`mcc`	`string`	✅	Mobile Country Code (3 digits)
`mnc`	`string`	✅	Mobile Network Code (2--3 digits)
`pcs`	`number`	✅	`0` or `1`
`name`	`string`	optional	Carrier name

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"connId":4,"selectedCarrier":{"mcc":"345","mnc":"23","pcs":0}}' \
  http://192.168.1.1/api/cmd.carrier.select

{
  "stat": "ok"
}

POST `/api/cmd.channelPci.lock`

Lock the connected LTE network on a specific channel number and Physical Layer Cell Identity (PCI).

Returns fail when the WAN connection does not support channel PCI lock.

Available in 8.1.1 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN connection ID to lock
`sim`	`array`	✅	List of `SIM` objects specifying channel and PCI

SIM Object:

Field	Type	Required	Description
`id`	`number`	✅	SIM ID: `1` for SIM A, `2` for SIM B
`value`	`object` or `null`	✅	`CH_PCI` object, or `null` to clear the lock

CH_PCI Object:

Field	Type	Required	Description
`channel`	`number`	✅	Channel to lock (0--65535)
`pci`	`number`	✅	PCI to lock (0--503)

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"connId":4,"sim":[{"id":1,"value":{"channel":1350,"pci":77}}]}' \
  http://192.168.1.1/api/cmd.channelPci.lock

{
  "stat": "ok"
}

POST `/api/cmd.channelPci.scan`

Scan for LTE cellular networks and obtain channel/PCI results.

Provide action=start to rescan. Returns fail when the WAN connection does not support channel PCI scan.

Available in 8.1.1 or later

Input Parameters

Field	Type	Required	Description
`action`	`string`	optional	`start` to trigger rescan
`connId`	`number`	✅	WAN connection ID to scan

Response

Field	Type	Description
`scanStatus`	`string`	`scanning` or `done`
`timestamp`	`integer`	Timestamp of the result
`list`	`array`	List of `CH_PCI` objects

CH_PCI Object:

Field	Type	Description
`pci`	`integer`	Physical-layer Cell Identity
`earfcn`	`integer`	E-UTRA Absolute radio-frequency channel number
`cellUtranId`	`integer`	Cell UTRAN ID
`plmn`	`array`	List of `PLMN` objects

PLMN Object:

Field	Type	Description
`mcc`	`string`	Mobile Country Code (3 digits)
`mnc`	`string`	Mobile Network Code (2--3 digits)

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"action":"start","connId":4}' \
  http://192.168.1.1/api/cmd.channelPci.scan

{
  "stat": "ok",
  "response": {
    "scanStatus": "scanning",
    "timestamp": 1577836800,
    "list": [
      {
        "pci": 371,
        "earfcn": 3000,
        "cellUtranId": 23574039,
        "plmn": [
          {
            "mcc": "454",
            "mnc": "00"
          }
        ]
      }
    ]
  }
}

POST `/api/cmd.cellularModule.rescanNetwork`

Rescan the network of the corresponding WAN connection.

Available in 8.0.0 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN connection ID of the cellular module to rescan

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"connId":"4"}' \
  http://192.168.1.1/api/cmd.cellularModule.rescanNetwork

{
  "stat": "ok"
}

POST `/api/cmd.cellularModule.reset`

Reset the cellular module of the corresponding WAN connection.

Available in 8.0.0 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN connection ID of the cellular module to reset

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"connId":"4"}' \
  http://192.168.1.1/api/cmd.cellularModule.reset

{
  "stat": "ok"
}

POST `/api/cmd.wan.cellular`

Change the SIM priority. The items in simPriority will be enabled and ordered as specified. The cellular scheme type will change to custom automatically.

Available in 8.3.0 or later

Input Parameters

Field	Type	Required	Description
`connId`	`number`	✅	WAN Connection of the cellular module
`simPriority`	`array`	✅	Priority list. Values: `1`, `2`, `remoteSim`, `speedfusionConnect5gLte`

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
  -X POST -d '{"connId":4,"simPriority":["1","remoteSim"]}' \
  http://192.168.1.1/api/cmd.wan.cellular

{
  "stat": "ok"
}

POST /api/cmd.billing.newCycle​

Input Parameters​

cURL Example​

GET /api/cmd.carrier.scan​

Input Parameters​

Response​

cURL Example​

POST /api/cmd.carrier.scan​

Input Parameters​

Response​

cURL Example​

POST /api/cmd.carrier.select​

Input Parameters​

cURL Example​

POST /api/cmd.channelPci.lock​

Input Parameters​

cURL Example​

POST /api/cmd.channelPci.scan​

Input Parameters​

Response​

cURL Example​

POST /api/cmd.cellularModule.rescanNetwork​

Input Parameters​

cURL Example​

POST /api/cmd.cellularModule.reset​

Input Parameters​

cURL Example​

POST /api/cmd.wan.cellular​

Input Parameters​

cURL Example​

POST `/api/cmd.billing.newCycle`

Input Parameters

cURL Example

GET `/api/cmd.carrier.scan`

Input Parameters

Response

cURL Example

POST `/api/cmd.carrier.scan`

Input Parameters

Response

cURL Example

POST `/api/cmd.carrier.select`

Input Parameters

cURL Example

POST `/api/cmd.channelPci.lock`

Input Parameters

cURL Example

POST `/api/cmd.channelPci.scan`

Input Parameters

Response

cURL Example

POST `/api/cmd.cellularModule.rescanNetwork`

Input Parameters

cURL Example

POST `/api/cmd.cellularModule.reset`

Input Parameters

cURL Example

POST `/api/cmd.wan.cellular`

Input Parameters

cURL Example