Aroma Shooter HTTP APIs

Aromajoin's HTTP APIs are available for Aroma Shooters with serial numbers beginning with “ASN2”. Using this API requires a Wi-Fi connection.

I. Wi-Fi connection setup

There are two methods of connecting an Aroma Shooter to a Wi-Fi network: via Aromajoin's official iOS application or via a web browser. Notes: In order to control Aroma Shooter, you have to setup WiFi and connect Aroma Shooter to the router. It could be not controlled in Hotspot mode.

Recommended Option - Web Browser

Here's an alternative method for people without iOS devices.

After plugging in your Aroma Shooter to a power source, choose it from the available Wi-Fi networks on your computer or mobile device. It will be identifiable by its serial number (For example: "ASN2A5216").

Password: aromajoin@1003

Using a web browser on your device, navigate to this address: http://192.168.1.1/

From the list of Wi-Fi networks, choose your preferred local network and enter your password. After about 30 seconds, the Aroma Shooter will connect to your local network. Please wait for the success message before refreshing or navigating away from the page. After you receive a message confirming a successful connection, tap the name of the Wi-Fi network again and take note of your device's IP Address -- you'll need this to send requests in Part II. You may now reconnect your computer/phone to the local network. It's time to try sending requests.

Option 2 - Aroma Shooter iOS app

The Aroma Shooter app is available on the Apple App Store:

https://apps.apple.com/app/aroma-shooter/id1477144583

After you install the app, tap the settings button in the bottom left corner of the screen, tap "Others," then tap "Setup AromaShooter's Wi-Fi," and follow the firmware version on-screen prompts. On the screen titled "Aroma Shooter Wi-Fi Connection," choose your preferred local Wi-Fi network and enter your credentials. After you receive a message confirming a successful connection, tap the name of the Wi-Fi network again and take note of your device's IP Address -- you'll need this to send requests in Part II. Tap "OK" then "Done" to return to the settings menu.

II. APIs

Now your Aroma Shooter is connected to a network through which it may receive HTTP requests, as long as you send the requests from a device on the same network. Using your preferred REST tools, submit requests via the following formats.

Hostname: http://[Aroma-Shooter_IP-Address] or http://[Device-serial].local

Port: 1003

The hostname structure should match one of these formats. Please do not copy these examples, as you must modify the IP addresses and/or serial numbers according to your Aroma Shooter(s):

IP address: http://192.168.1.10:1003 (This format is recommended, since it handles requests very quickly.)
Device serial: http://ASN2A00001.local:1003 (This format may seem intuitive, but it handles requests slowly and is incompatible with Android devices.)

API Lists

1. Get firmware information

Path: /as2/firmware
Method: GET
Header: “Content-Type: application/json”
Response sample:

{
    "current": "1.0.0",
    "latest": "1.0.1",
    "internet": "true"
}

2. Diffuse scents

Path: /as2/diffuse
Method: POST
Header: “Content-Type: application/json”
Request body:

Firmware version 2.x.x and later

{
    "channels": [Number, ...], // The cartridge number. Range: 1 ~ 6
    "intensities": [Number, ...], // The cartridge intensity as a percentage. Range: 0 ~ 100
    "durations": [Number, ...], // Diffusion time in milliseconds. Range: 0 ~ 10000
    "booster": Boolean // Set to true to activate the Aroma Shooter's booster fan. Default value is false.
}

Request sample:

{
    "channels": [1,3,5],
    "intensities": [100,50,25],
    "durations": [1000,2000,3000],
    "booster": true
}

Firmware version 1.x.x

{
    "duration": Number, // Diffusion time in milliseconds. Range: 0 ~ 10000
    "channel": Number, // The cartridge number. Range: 1 ~ 6
    "intensity": Number, // The cartridge intensity as a percentage. Range: 0 ~ 100
    "booster": Boolean // Set to true to activate the Aroma Shooter's booster fan. Default value is false.
}

{
    "duration": 3000,
    "channel": 3,
    "intensity": 100,
    "booster": true
}

Response sample:

{
    "status": "done"
}

3. Stop diffusing

Path: /as2/stop_all
Method: POST
Header: “Content-Type: application/json”
Request body: None
Response sample:

Firmware version 2.x.x and later

{
    "serial":"ASN2A00001",
    "status":"done"
}

Firmware version 1.x.x

{
    "status": "done"
}

FAQs

Why I could not see Aroma Shooter’s Wi-Fi hotspot?

To save the device energy and resource, the hotspot will be automatically disabled in two following scenarios. If Aroma Shooter is already connected to a Wi-Fi network, the hotspot is automatically off. If Aroma Shooter is being controlled via USB or Bluetooth, the hotspot and Wi-Fi connection ability is disabled. Therefore, to set up Wi-Fi for Aroma Shooter, it is necessary to turn it off and on again if it is controlled via PCs or smart phones.

How can I confirm if Aroma Shooter is already connected to a Wi-Fi router?

The simplest way is to use IP scanning software on a PC or mobile phone that is connected to the same Wi-Fi router. It will help you to scan all the IP addresses in the same network, so you can check if Aroma Shooter IP address is listed there. If it is listed there, it means that it is connected successfully. For example, if you are using Windows PC, you can use Advanced IP Scanner.

Does the Wi-Fi settings are kept in case of power down?

Yes. The WiFi settings are kept even the power is down. It only changes when you connect the device to another network.

How long the Wi-Fi information is retained?

It is retained forever and changes only when the device is connected to another network.

How can we change the Wi-Fi settings?

When you bring the device to other places where the device can not connect to the last connected Wi-Fi access point, the device will automatically turn on its Wi-Fi hotspot. Then, you can connect and set up Wi-Fi settings again.

Ekristoffe / controller-http-api