developer portal

Documentation

edgeSDK for IoT devs

Prerequisites

  1. Download and install the latest version of edgeSDK on your computer.

Important: Please follow the installation guide after download.

  1. Download and install the latest version of node.js on your computer.
  2. Create your mimik developer account here.

Step 1. Create an edgeSDK project

  1. Sign in to mimik developer console.
  2. In the mimik developer console, click Create Project.
  3. Enter a Project Name.
  4. Upload a logo image if you want to use your own Project Logo.
  5. Submit the form with the auto-generated Redirect URI or enter your own.

Important: edgeSDK uses OAuth 2.0 for authentication and a redirect URI is necessary for the process. The standard format of redirect URI is com.<string>://<string>. You can learn more about it here.

Step 2. Authenticate and authorize edgeSDK on your machine

  1. Download and install the latest edgeSDK OAuth Tool on your computer.
  2. Sign in to mimik develop console again and click on Open OAuth Tool under Projects.

Important: This will launch the installed OAuth Tool on your computer.

  1. Select your intended edgeSDK project for developing your current microservice.
  2. Change device's local IP address to the IP address of your intended authenticate device (your computer or IoT Device).

Important: You can delete localhost if you don't want to associate edgeSDK on your computer.

  1. Click Get edge Access Token to prompt a new log in session.
  2. After successful login, the Associate Device button should now be active.
  3. Click Associate Device and now edgeSDK is authenticated and authorized on your machine.

Step 3. Deploy and run edge microservice

If you want to build your own edge microservice, follow our starter guide for microservice development.

If you are not ready developing your own edge microservice, feel free to use our open source edge microservice to get started. To build and deploy our open source edge microservice, please read our guide on building edge microservice and deploying edge microservice.

Need more help?

Feel free to contact us on stack overflow or send us a question via our support page if you have any questions.

Was this page helpful?