This extension will assist you working with SORACOM Napter with Visual Studio Code.
Napter is an on-demand networking service for devices using Soracom Air for Cellular SIM cards, which enables you to quickly and securely access your devices remotely. Napter allows you to perform remote maintenance, troubleshooting, or other typical remote access tasks, without setting up any relay servers or installing agent software on the device.
Requirements
Usage
You can open SORACOM Napter Tools view which you can see list of your SIMs and details by one of following methods:
- Click the icon
in the Activity Bar
- Open Command Palette (⇧⌘P) then type Show SORACOM Napter Tools
- Default shortcut key (⌃⇧N)
You can see your active SIMs and list, create, and delete Napter port mappings. Use icon described below or right click view items to find available actions.
| Icon |
Command |
Description |
 |
SORACOM Napter: Create New Port Mapping |
Create new port mapping. |
| - |
SORACOM Napter: Delete Port Mapping |
Delete existing port mapping. Also you can delete port mapping from right click menu. |
 |
SORACOM Napter: Connect via Visual Studio Code 'Remote - SSH' Extension |
- Open new window with connecting the port mapping if you set
soracom.napter.ssh.autoConnection to true. - Otherwise open input box for the Remote - SSH extension while copying connection string (
ssh://user@host:port) in the clipboard. You can paste it and press enter to connect.
|
 |
SORACOM Napter: Refresh SIMs List |
Refresh Active SORACOM SIMs view in the SORACOM Napter Tools view. |
 |
SORACOM Napter: Toggle Coverage |
Toggle coverage between Japan and Global. |
 |
- |
Copy item value to the clipboard if applicable. |
SIM Detail View
When you select a SIM at Active SORACOM SIMs view, detail of the SIM will be displayed.
| Icon |
Command |
Description |
|
SORACOM Napter: Refresh SIM Status |
Refresh SIM Detail view in the SORACOM Napter Tools view. |
|
- |
Copy item value to the clipboard if applicable. |
Status Bar
Your user name and SORACOM operator ID will be displayed in the status bar once API authentication succeeded. Click the status bar item to open SORACOM User Console.
Extension Settings
This extension contributes the following settings.
| Key |
Description |
soracom.auth.useCliConfiguration |
Use soracom-cli configuration files (.soracom/*.json under $SORACOM_PROFILE_DIR or $HOME directory) instead of AuthKey ID and Secret configured above. Restart required when changed. |
soracom.auth.profileName |
Profile name (filename without .json) for your soracom-cli setup. Effective if Soracom > Auth: Use Cli Configuration (soracom.auth.useCliConfiguration) is enabled. |
soracom.auth.authkey.id |
SORACOM API AuthKey ID |
soracom.auth.authkey.secret |
SORACOM API AuthKey secret |
soracom.endpoint |
Specifies coverage for SORACOM |
soracom.napter.duration |
Specifies default minutes for SORACOM Napter port mapping duration |
soracom.napter.port |
Specifies default remote port number for SORACOM Napter port mapping |
soracom.napter.ssh.user |
Specifies default remote user name for SORACOM Napter port mapping |
soracom.napter.ssh.autoConnection |
Connect via Remote - SSH extension automatically after creating port mapping. |
soracom.mask |
Controls mask of user identifiable information such as Operator ID, IMSI, IP address, port, etc. |
Supported Authentication Method
Authkey method is recommended for security reason. Email and password should work (except you configured multi-factor authentication) but not tested.
| User type |
Email and password |
AuthKey ID and secret |
| Root account |
- |
tested |
| SAM user |
- |
tested |
Known Limitation
- You cannot specify source IP addresses ranges.
- No API sandbox support.
- No test.
TODOs or Ideas
- implement i18n?
- display SIMs group by SIM group?
- display SIMs group by coverage?
References
Contributing
Please read CONTRIBUTING for details.
License
MIT. See LICENSE for details.
See license for SORACOM Icons Set and microsoft/vscode-icons for icons.
Enjoy remote development with SORACOM Napter!
