Speed Class

Similar to AWS EC2 instance sizes and the Azure VM series, Soracom IoT SIMs can be configured to adjust the maximum upload and download bandwidth. Adjustments are made by setting an IoT SIM's Speed Class, with each class corresponding to a specific bandwidth:

Global Coverage:

Japan Coverage:

^{*1 - Although t1.standard allows for download and upload speeds up to 2Mbps; throughput is limited by the LTE Cat-M1 network, and actual network speeds may be lower.}

Off-Peak Pricing: The price (cost per MB of traffic) of and SIMs is based on its speed class, with s1.minimum being the most economical. However, during off-peak hours from 2

am to 6

am (JST), all speed classes are reduced to a discounted price, with no difference in pricing between speed classes. This allows you to take advantage of low s1.minimum fees for basic data applications, then ramp up to s1.fast in the evening for heavier workloads such as downloading firmware updates or uploading buffered data.

Subscription containers inherit the speed class of the , , or SIM card that they are added to.

Changing a Speed Class

For and SIMs, changing the speed class may affect the data usage cost.

1. Sign in to the User Console . From the Menu, open the SIM Management screen.

2. From the list of subscribers, click the **** for the SIM you want to manage.

3. Click the **Actions ** menu, then select Change speed class.

   

4. In the dialog, select the new speed class for the SIM, then click Change Speed Class.

   

The new speed class is effective immediately.

Alternatively, you can also change the speed class directly from the list of SIMs. Simply find the Speed class column for the SIM you want to update and click the icon next to the current speed class and the same dialog box will appear allowing you to change the speed class of your SIM.

Limitations

The following limitations apply to Soracom IoT SIM speed classes:

• When data transmission exceeds the rate defined by the speed class, the excess data may be lost.
• If a SIM contains multiple subscriptions through its use of Subscription Containers, applying a speed class to the SIM will change the speed class of all of its subscriptions. Speed classes cannot be changed for individual subscriptions.
• If a new subscription is added to a SIM whose speed class is set to a lower class than the default speed of the new subscription, the new subscription will use the lower speed class by default.

Programmatic Usage

In addition to configuring the speed class of each SIM from the User Console, you can also perform the same configuration programmatically, allowing you to integrate automated control of your device's bandwidth inside of your application.

Soracom API

To access the Soracom API, first use the auth API to obtain an API Key and Token. Refer to the API Usage Guide for instructions on how to use the API Key and Token in API requests.

Use the updateSimSpeedClass API to change the speed class of an IoT SIM:

curl -X POST \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  -H 'Content-Type: application/json' \
|  -d '{
|        "speedClass": "s1.standard"
|      }' \
|  https://g.api.soracom.io/v1/sims/<SIM-ID>/update_speed_class

curl -X POST \
|  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
|  -H 'X-Soracom-Token: <MY-TOKEN>' \
|  -H 'Content-Type: application/json' \
|  -d '{
|        "speedClass": "s1.standard"
|      }' \
|  https://jp.api.soracom.io/v1/sims/<SIM-ID>/update_speed_class

Soracom CLI

To use the Soracom CLI, you must first configure it to authenticate with your account information, authorization key, or SAM user credentials.

Run the following command to change the speed class of an IoT SIM:

soracom sims update-speed-class --sim-id <SIM-ID> --speed-class "s1.standard" --coverage-type g

soracom sims update-speed-class --sim-id <SIM-ID> --speed-class "s1.standard" --coverage-type jp

Metadata Service

The Metadata Service allows an Air SIM device to access and configure its own settings without the need for authentication. For more information, refer to the Metadata Service documentation.

To change the speed class of an IoT SIM, the Metadata Service Readonly option must be disabled. Then, from the IoT SIM device, use the updateSpeedClass API (via Metadata Service):

curl -X POST \
|  -H 'Content-Type: application/json' \
|  -d '{
|        "speedClass": "s1.standard"
|      }' \
|  http://metadata.soracom.io/v1/subscriber/update_speed_class