Professional Documents
Culture Documents
Page 1 of 10
Table of Contents
1 HOWTO Notify My Android (NMA).......................................................................... 3
1.1 Introduction............................................................................................................................... 3
1.2 Requirements............................................................................................................................ 3
1.3 NMA API Key............................................................................................................................ 3
1.4 DomotiGa Setup....................................................................................................................... 6
1.5 DomotiGa Event/Action............................................................................................................. 7
1.6 FAQ........................................................................................................................................... 8
Page 2 of 10
Introduction
This is the HOWTO to setup and use the Notify My Android, here after named
NMA. NMA is a platform that allows you to delivery push notifications from virtually
any application to your Android device. They offer a client application that runs on
your Android device and a set of easy to use public APIs that can be integrated into
software.
1.2
Requirements
This HOWTO and NMA have the following requirements:
NMA API Key, this one can be created/requested in the following steps
NMA installed on your Android device. The exact name in the Play Store is
Notify My Android
1.3
from
Page 3 of 10
After you clicked on the register link, then the website will show you the
following web page. Here you can register for a free NMA account and supply your
username, password an email address.
Supply an unique username, password and email address. Don't forget to enter the
Captcha, else you can't register. In the following example the username is
DomotiGa. When finished, click on the bottom register button.
Page 4 of 10
If your supplied information is correct, it will show you the following web page. In
this example the username DomotiGa is successfully registered. Now you should
login, click on the Proceed to Login link.
Now login in with your credentials, supplied during register and click on the bottom
login button.
If the credentials are correct, the following web page is shown and you're logged in.
At this moment you don't have an API key yet. To create a new API key, click on the
bottom Generate New Key button.
Page 5 of 10
After you clicked on the Generate Key button the following web page is shown,
with your just generated API key. This API key is a 48-byte hexadecimal string.
Copy or write down the generated NMA API key, this is required to be configured in
DomotiGa.
1.4
DomotiGa Setup
After you registered an account and generated an API key, you can configure this
API key in DomotiGa. Start the DomotiGa GUI and go to the Notify My Android
module. This module is located in the top menu bar, click on Modules =>
Notifiers => Notify My Android. This will give you the following screen. By
default the module is disabled, click on the Module Enabled option to enable it
now.
After the module is enabled, you can configure your NMA API key. This is the 48byte hexadecimal string from the NMA website. Supply this key in the NMA API
key input field.
Page 6 of 10
Additionally you can configure the Application and Event input fields. These
fields are mandatory for the NMA notification. In the example below the
Application field is Github and the Event field is Commit. The rest of the
text is the message.
Before you click on the Save button it is highly recommended to execute the
Validate API key and Send Message. If both are successful then you know it
has been setup and is working.
When you click on the Validate API key button and your key is valid, you will
see the following message on your screen. If you get an invalid message,
please check your API key and retry.
When you click on Send Message and if they key is valid and is accepted by the
NMA site, you will get the following message on your screen. Check your NMA
application on your Android if the message is successfully received. The message
text will be Test message from DomotiGa :-).
Now NMA is successfully setup and please click on the Save button to save your
Notify My Android settings.
1.5
DomotiGa Event/Action
After the Notify My Android module has been setup you can use the NMA as a
DomotiGa action in an event to send messages. To create a new action go top
Page 7 of 10
menu bar, click on Events => Add Action. This will give you the following
screen.
Click on the Action Type and select the Send Notify My android from the
list. Supply the other information like Name, Description and the Message and
click on the Save button.
Now you can use this action in your events. You can define as many different NMA
notification messages as you want.
1.6
FAQ
The following Frequently Asked Questions should give you answers to most
common questions or problems.
Page 8 of 10
Page 9 of 10
Version History
Version
Status
Date
1.00
DRAFT
1.01
DRAFT
Details of Changes
Author(s)
28-July-2013
Initial version
Alexie
04-Aug-2013
Alexie
Page 10 of 10