Filter results by

Web tools

The Developer Dashboard and My ARTIK Cloud provide an easy, intuitive way for you to assess and modify your applications, devices, organization, and pricing plan. This article walks you through their primary features.

Both web tools require an ARTIK Cloud Account. Follow these steps to create an account after logging into either tool for the first time.

Create an ARTIK Cloud Account

  • Click the "SIGN UP" button at the top of the developer site.
  • Fill out the required fields on the next page. Note the password character requirements.
    ARTIK Cloud Account sign up
  • You will be sent an activation email. Click the link to complete your registration.
  • Now you can sign into ARTIK cloud services!

If you have an existing Samsung, Google or Naver account, sign up for an ARTIK Cloud Account using the same email address to link your existing account to your new account.

Inside the Developer Dashboard

The Developer Dashboard is integrated with the developer site.

Creating an application

The first time an application is created in an organization, an administrator must accept the ARTIK cloud services Terms and Conditions.

  • Click "Applications" at the top of the page. Click the "+ New Application" button.
  • Fill in an application name and description. Note the characters <,>,&,'," are not allowed.
  • Choose an OAuth2 grant type and a redirect URL. (See Authentication and Selecting authentication methods for more details.)
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • Click "Save Application". This takes you to a detailed view of your applications.
  • Set permissions for your application.
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
    • Choose "Read" and/or "Write" permissions.
      • You may also "Set Permissions for a Specific Device".
      • Select a published device type from the pulldown that appears after clicking this option.
      • Choose "Read" and/or "Write" permissions for the device type.
  • Click "Save".

How to find your application ID

You will need your application ID (called a client ID in the Developer Dashboard) to use in API calls. Here's how to locate it.

  • Click "Applications" at the top of the page to view your list of applications.
  • Select the application from the list to the left.
  • To the right, click "Show Client ID & Secret".
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
    • The application ID is the string found next to "Client ID".
      ARTIK Cloud Developer Dashboard and My ARTIK Cloud

Creating a device type

Creating and publishing a device type makes it available to all developers that want to store data in ARTIK cloud services using a client of this device type.

The first time a device type is created in an organization, an administrator must accept the ARTIK cloud services Terms and Conditions.

  • Click "Device Types" at the top of the page to view your device types. Click the "+ New Device Type" button.
  • Enter a display name and unique name (a valid example is given) for your device type. Note the characters <,>,&,'," are not allowed.
  • Click "Create Device Type." This takes you to a detailed view of your device types.
  • Click "+ New Manifest" to enter Manifest creation.
  • Enter at least one field name, data type and unit. The characters <,>,&,'," are not allowed. The form auto-suggests standard fields and units as you type. You may also click the "Browse" links to see all the available options. Click "Save".
  • Click the "Device Actions" tab to optionally add Actions the device type is capable of receiving. As with the device fields, the form auto-suggests standard Actions as you type, or you may click "Browse" to see the Actions that are already available. Click "Save".
  • After you have entered all fields and Actions for your Manifest, click the "Activate Manifest" button on the corresponding tab to enable your Manifest.

Publishing a device type

Published device types must be associated with an organization. See Creating an organization.

  • Once your device type has a Manifest, you may want to publish the device to make it available to all developers on ARTIK cloud services. By default, it has a status of "private".
  • To publish the device type, you must populate the Device Info page. Click the "Device Info" link to the left.
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • Add a description and choose at least one category and tag. Click "Save Changes".
  • You may now change the "private" status by clicking "Change" and selecting "Users of your applications" or "Everyone on the ARTIK Cloud platform".
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • After clicking "Save Changes", the status is changed to "published".

If you upgrade to a paid plan, you must limit who can use the device type.

Updating a device type

ARTIK Cloud Developer Dashboard and My ARTIK Cloud

  • You can update your device type Manifest by clicking the "Manifest" link to the left.
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • Click "+ New Version" to create a new Manifest.
    • Alternatively, click the arrow icon to upload a JSON snippet that defines the fields and Actions. ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • After updating, you will see a new Manifest version number and status for your device type.

Creating an organization

An organization is a way to manage billing, users, and metrics for your device types. When you first log in, you will not be a member of an organization. You must create your organization before publishing any device types.

  • When signed in, click your username at the top-right and select "View Organization".
  • Click "+ New Organization".
  • Fill in your company details and click "Save Changes".

As the sole user of your organization, you have an administrator role by default. In addition to managing payment information for the organization's pricing plan, administrators may invite users to join their organization with specific roles. If you do not plan to serve as an admin, another user invited to join the organization as an administrator can change your role later.

The applications and device types created by developers in your organization are made available to all members.

Managing your organization

As the organization grows, an administrator may invite more users to join the organization in one of four roles: administrator, developer, tester, and metrics.

The privileges for each role vary. Only administrators may change organization, billing, user, and pricing plan information. An administrator may grant more than one role to a user.

An ARTIK cloud services user can belong to one organization.

  • When signed in, click your username at the top-right and select "View Organization".
  • Click "Manage Users" in the left-hand menu. Note: You must have an administrator role.
  • Enter an email address, select a role, and click "Send Invitation".
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • Once the user accepts the invitation in their email inbox, they will appear in the users table.
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
  • You may change user role(s) in this table.

Changing your pricing plan

Your current pricing plan and data usage are displayed in the "Usage & Billing" section of the Dashboard. The default plan is Free.

ARTIK Cloud Developer Dashboard and My ARTIK Cloud

Depending on your organization, you may want to upgrade to a different plan. This page details the available pricing plans: Free, Small Business, and Enterprise.

  • Click "Usage & Billing" at the top of the page.
  • Click the "Upgrade" button underneath your current pricing plan. Select a new plan from the pulldown menu.
    ARTIK Cloud Developer Dashboard and My ARTIK Cloud
    • If you select the Small Business Plan, fill in and save your payment information. This is a pay-as-you-go plan with monthly billing.
    • If you select the Enterprise Plan, send us a message regarding your specific business needs. An Enterprise Plan is ideal if you have large scale deployments with a need for custom data retention period, an availability SLA, and enterprise support.

When switching to a paid plan, your organization's messages will begin counting toward the new plan at the start of the next day.

Inside My ARTIK Cloud

My ARTIK Cloud is located at the ARTIK cloud services main site. Click "My ARTIK Cloud" at the top of the developer site. On this page, you can connect devices, view data, and create Rules.

ARTIK Cloud Developer Dashboard and My ARTIK Cloud

Our Hello, World! guide puts My ARTIK Cloud functionality into context.

Connecting a device

  • Click the "My ARTIK Cloud" link next to your username at the top-right.
    • If you already have connected devices, click "+ Connect another device…".
  • In the box, start typing the name of your device.
    • The available options will pop up. Select one.
  • Click the "Connect Device…" button.

Read our blog to learn about My ARTIK Cloud's powerful Data Visualization feature.

Managing a device token

Click the name of a connected device in My ARTIK Cloud. A window like the following will appear.

ARTIK Cloud generate device token

Click "GENERATE DEVICE TOKEN…" to get a device token for this device. When you are ready to revoke the token, click "REVOKE TOKEN".

Creating a Rule

With this feature, you can create Rules for triggering device Actions based on the contents of ARTIK cloud services messages.

ARTIK Cloud Rules

You define a Rule by selecting device fields and values, conditionals, and commands to send. The process looks like this:

  • Select Rules from the My ARTIK Cloud menu.
  • This will take you to the Rule creation page.
  • Create an optional schedule for your Rule by setting a time and/or date range.
  • In the IF pane, select a device from your device list. This will bring up the data fields defined in its Manifest.
    • Now select a field to use.
      ARTIK Cloud Rules
  • In the next dialog, choose an operator such as "is equal to" or "is more than", and then specify an operand value.
    • You can optionally specify a duration condition.
  • A Rule can also be triggered by the output of a machine learning model. Learn more here.
    • The Rule defaults to using the actual value of the data field. You can instead use a predicted value by clicking the dropdown arrow next to Actual Value. Then select this option and a delta time for predictions.
      ARTIK Cloud Rules
    • When evaluating actual values, you can select "an expected value" or "an unexpected value" as the operator, with a corresponding confidence level. This is known as Anomaly Detection.
      ARTIK Cloud Rules
  • In the THEN pane, select a device and a command to send. This may be a standard Action or a custom JSON command.
    ARTIK Cloud Rules
  • Click "Save Rule". Note the description auto-populates from your choices.
  • You will be taken to your Rules dashboard. Here you can edit, clone, test, enable/disable and delete your Rules.
    ARTIK Cloud Rules

Read our blog post to learn more about Rules.

Creating a Scene

A Scene is a group of Actions sent to one or more devices. Define a Scene by selecting devices to include and Actions to send to them.

  • Select Scenes from the My ARTIK Cloud menu.
  • Click "+Add Another Scene".
  • Select a device to add. To select all devices of a device type, make a selection underneath the "Every" section.
    ARTIK cloud services Scenes
  • Set an Action and any applicable parameters to send to the device.
    ARTIK cloud services Scenes
  • Click "Save & add another" to repeat the process until done.
    • Alternatively, you can click the "Import Actions from Rule" link to quickly create a Scene based on an existing Rule.
    • Select a Rule and then check the Actions you wish to import to the Scene from that Rule.
      ARTIK cloud services Scenes
  • The devices and Actions in the Scene will be displayed.
    ARTIK cloud services Scenes
  • Provide a Name and Description for your Scene and click "Save".
  • On the Scenes page afterward, you can click "Activate Scene" to run the Actions on each Scene.
    ARTIK cloud services Scenes

Using the Online Device Simulator

The Online Device Simulator simulates data output from your connected devices. You can use it to easily test a device type for which you don't have an actual device to generate data. This web-based tool is separate from the Command Line Device Simulator.

Simulated data generated by the Online Device Simulator will count toward your pricing plan.

  • On the left-hand side of the Devices page, click "Show Simulator".
  • The Online Device Simulator opens in the right sidebar. Click "Select A Device" to get started, or "Import Scenario" to load a saved JSON configuration.
  • Select a device and data field to simulate. Click "Next".
  • In the next window, define the data pattern and time interval for the simulated data. The data pattern can have one of four types:
    ARTIK Cloud Online Device Simulator
    • Random makes random selections from a comma-separated list of range of values.
    • Increment steps up to a maximum value, and can repeat with the maximum is reached.
    • Constant value outputs one value.
    • Cycle alternates between a comma-separated series of values.
  • Click "Start Simulation" when all data fields have been added.
    ARTIK Cloud Online Device Simulator
    • You can pause the simulation by clicking "Pause" in the banner that appears.
  • Data will be sent in real-time to ARTIK cloud services. You can see this reflected in the Charts and Logs sections.