Get Started with Super SIM IP Commands and the Raspberry Pi Pico
PreviousGet Started with Super SIM IP Commands and the Raspberry PiNextGet Started with Super SIM eSIM Profiles for eUICCs
Last updated
Last updated
IP Commands is a new Super SIM feature that allows your cloud to communicate with your IoT devices by exchanging UDP/IP messages. You can use IP Commands to send server-initiated messages from your cloud to your Super SIM-connected devices, and to have the responses directed to the endpoint of your choice. The best part is that you don't actually need to know a device's IP address — KORE will handle that for you. Nor do you need to maintain a persistent connection between a device and your server.
You can think of IP Commands as a lightweight alternative to using a Virtual Private Network (VPN) to reach a device from your cloud and exchange information.
This information is transferred in the form of User Datagram Protocol (UDP) messages. UDP provides basic, 'fire and forget' data exchange: there's no connection established between sender and receiver — but no guarantee that the message will be delivered. This simplicity makes UDP ideal for lightweight IoT applications: it's a great way to send commands (i.e., "change the air con setting to 40C", etc.) to a connected device. Such commands might come from your cloud, or from an app running on an end-user's mobile device. Typically, they would be more structured than the colloquial example shown above, but completely flexible: your application, not the transport, defines the command-response interaction.
To show you how to use Super SIM IP Commands, we're going to make use of the Raspberry Pi Pico microcontroller development board. The Pico is highly programmable. Though it's intended for traditional embedded applications, and therefore supports C/C++ development, it can also be used with MicroPython, a version of the popular language that's been tailored for use with microcontrollers rather than full PCs. This means that anyone who's used Python can quickly begin prototyping their own IoT devices with the Pico and Super SIM.
The Pico's RP2040 microcontroller is available in commercial quantities, so the development work you do can readily form the basis for production devices later.
This guide requires a KORE account. Sign up here now if you don't have one. It also requires a configured Super SIM. If you haven't set up your Super SIM in the Console, please do so now. Our Super SIM First Steps guide has extra help if you need it.
To complete this tutorial, you will need:
These are widely available from many online electronics suppliers.
A Waveshare Pico SIM7080 cellular modem
You can order one direct from Waveshare.
An HT16K33-based four-digit, seven-segment LED
Adafruit sells a good one here.
A micro USB cable to power the hardware and connect it to your computer.
Some jumper wires and a solderless breadboard.
You will also need to install curl for your platform.
This tutorial assumes your Pico has MicroPython installed. Out of the box this is not the case, but our tutorial Get Started with Super SIM SMS Commands and the Raspberry Pi Pico will show you how to set up your device and to prepare the other components for use. It will also show you the software you need on your computer. If this is your first Super SIM Raspberry Pi Pico tutorial, hop over there now to get set up. Come back here when you've completed Step 4 .
If you've already finished the Get Started tutorial, you're ready to continue here.
At this point, you should have your Pico ready to go, fitted to the Waveshare module, and connected up like this:
You should have Minicom, or a similar terminal emulator, installed on your computer.
Run Minicom. Now hit Ctrl-C to break to the Python REPL. You won't use the REPL directly, but it provides a way to enter large blocks of MicroPython code. Hit Ctrl-E. This tells MicroPython to accept a full Python program pasted in. Click on the button at the top right of the following code to copy it and then paste it into Minicom. The copy button will appear when you mouse over the code. When you've pasted the code, hit Ctrl-D.
You can find the a complete listing of the code, including all subsequent additions, at our public GitHub repo.
If you've copied the code, you can click to jump down the page.
This is the basis of the code you'll work on through the remainder of the guide, so you should also paste it into a text editor where you can make the subsequent changes and additions, and then copy everything at each stage over to the Pico as described above.
MicroPython will check the code and, if it's free of syntax errors, run it. You'll see status messages appear in Minicom as the code boots the cellular module and configures it, and then connects to the network. You know you're ready for the next step when you see the message Listening for IP commands... in Minicom.
These states are also reflected in the Pico's green LED. It will be off initially, but blink slowly while the device is attempting to attach to the cellular network. When the Pico has done so, the LED will stay lit.
If the LED blinks rapidly five times, the Pico could not start the module. Check your soldering and that you have connected the Pico to the module correctly.
Open a second terminal or a new terminal tab on your computer.
Send a command using the curl tool as follows:
Copy and paste the curl command to the command line then edit it to fill in the identifier of the Super SIM you're using (you can get this from the Console if you don't have it handy), and your account credentials (also available from the Build portal). The message is the value of the Payload parameter, in this example - "BLUE". Make sure you set the DevicePort value to the one you chose when you configured the UDP socket in the previous section.
The response from curl, posted to the terminal, will look something like this:
As you can see, the message's status is queued: it's in KORE's message queue waiting to be sent. When the IP Command leaves the KORE Mobile Core for the network the device is attached to, its status will become sent. Later on, you'll use a webhook, which you'll set up in the next section, to receive notifications about message status changes as they happen. For details of the possible status values you may see, take a look at the API documentation.
If you prefer to use a different port number, just change the value of `DevicePort` in the curl command above and in the Python code — it's set in the function start_udp_session().
Look at Minicom's output. Has the Pico reported that it received the command BLUE?
In a real-world application the IP Command would come from your server, not be sent manually, and your device-side application would parse any that arrive and perform actions accordingly. However, the demo gives you a picture of the flow. IP Commands also supports binary data. To send information in this form, you would set the PayloadType parameter to "binary":
Logging a received command is a good start, but it's not particularly exciting. Let's make use of the four-digit display so show some values in bold color.
The display needs code to drive it. Rather than include it all here, just grab the code you need from this public GitHub repo. You want the contents of two files. Click the links below to view the raw code in your browser, then copy and paste each one into your text editor, right below the import statements at the top.
With the second file, make sure you copy only the class declaration — ignore the first two lines above it (starting # Import the base class...).
Now add the following function right after the existing listen() function:
Add this line to the listen() function, right after print("Command received:",cmd):
Finally, add the following lines after the # Setup the modem UART block:
Copy all the new code from your text editor and paste it to the Pico in the usual way.
Now send a slightly different command via the IP Commands API:
Again, you'll need to do this in a separate terminal tab or window, and replace the <...> sections with your own data.
After a moment or two you should see 1234 appear on the LED. If it doesn't appear after a short time, check you have the LED wired to the Pico correctly — take a look at the wiring diagram. If you see Setting 1234 on the LED in Minicom, you know the command was received. If not, did you enter the command above correctly? Perhaps you mis-typed the payload value. You'll see an error message in Minicom in this case.
Now it's time to make the conversation two way.
The IP Commands API provides a specific IP address, 100.60.0.1, to which all IP Commands, from every device should be sent. KORE uses a little bit of magic to streamline the relay of your messages to your cloud. How does it know where to send them? You specify a webhook address.
Super SIMs are organized into Fleets: groups of SIMs that have common settings, such as which networks they are able to connect to and whether they can make use of certain cellular services. Fleets are represented in the Super SIM API by Fleet resources, and IP Commands adds a property to each Fleet resource in which you can store your IP Commands webhook address.
So before we can send a message, we need to set up a webhook target URL and add that to your Super SIM's Fleet.
Beeceptor is a handy service for testing webhooks. It's designed for developing and testing APIs of your own, and offers free mock servers — virtual endpoints that can receive webhook calls. Let's set one up to receive messages from the device.
In a web browser tab, go to Beeceptor.
Enter an endpoint name and click Create Endpoint:
On the screen that appears next, click on the upper of the two clipboard icons to copy the endpoint URL:
Keep the tab open.
Now you update your Super SIM's Fleet to add an IP Commands webhook. You can do this with the API, but we'll use the Console for this demo.
Open a second web browser tab and log into the KORE Console.
Launch Super SIM, click Fleets and select the Fleet containing the Super SIM you are using.
Scroll down to IP Commands Callback URL and paste in your webhook URL from the previous section. By default, webhooks are triggered with a POST request. Leave it unchanged for now, but if you need to use another method for your own application, you can change it later.
Click Save.
Close the tab if you like.
To add message sending to the device code, you can add following function after all the other function definitions:
Now add these two lines into the function process_cmd(), right after process_command_num(val):
Finally, add this line to the end of the function start_udp_session():
Save the file and copy it across to the Pico.
Let's quickly take a look at that last addition as it's key. The AT command +CACFG is a Simcom-only command that performs a specific configuration option. That option is "REMOTEADDR" — it sets the remote IP address all future UDP messages will be transmitted to, at least until the value is changed.
Which address do we apply? 100.64.0.1, the third parameter passed with the command. This is the standard IP Commands input address. The last parameter, 6969, is the local port number.
Send a new command, SEND, via different command via the IP Commands API:
Jump back to the Beeceptor tab in the browser. You should see — or will shortly see — the endpoint has received a POST request. Click on it to see the request body, then on the JSON icon, {:}, to view the data more clearly.
Unlike messages sent to the device, which can be text or binary, messages that are sent from the device always arrive in binary form. The string sent as a result of your SEND command has been base64 encoded, so it'll need decoding before you can read it. Look for the line beginning Payload= and copy the characters that appear after it, up until the end of the line. It'll look something like this:
Switch to a spare terminal and enter:
making sure you paste the text you copied between the echo and the | symbol as indicated. You'll be presented with the message in English:
The webhook URL you just put in place was set up to receive IP Commands from the device. You can also use it in a tutorial context for monitoring messages being sent to the device. Use the same technique you applied in the Send IP Commands to the device section, above, but this time add the following extra command to the curl call: CallbackUrl followed by an equal sign and then your Beeceptor endpoint.
Now you'll receive a series of notification messages as the IP Command's status moves from queued to sent. For details of the possible status values you may see, take a look at the API documentation.
You've set up a Raspberry Pi Pico and Simcom SIM7080 cellular module to send and receive UDP messages over a data connection, then you've actually sent those messages through KORE Super SIM's IP Commands API.
You can try sending some alternative messages, including some binary data.
Try using IP Commands to toggle GPIO pins so the Pico can begin to control things. Create a web page to call the API and trigger the commands.
IP Command Resources are persisted for 30 days, so you can check your send and receive histories at any time. For example, a GET request made to https://supersim.api.korewireless.com/v1/IpCommands will fetch all existing resources for inspection. If you have the SID of a specific Command's resource, you can add it as a path value to the endpoint above. Try it now.
The next stage, of course, is to build a device-side app that listens for a variety of commands, parses them and triggers actions accordingly. You may also want to create a server app that's able to request information from devices: it sends a request command which causes the device to send a second, data-bearing message back. Or you might code up a mobile app that uses IP Commands to control the device remotely.
We can't wait to see what you build with Super SIM IP Commands!
