Water Metering System Application for TagoIO

This is a starter application to be used at TagoIO. It has main required features for an regular application to run, with a functionality to facilitate setting up new sensors within the application. You can use the scripts provided here to learn or to develop your own solution with it's foundations.

Components

The application contains the following features:

• Two levels: Organization and Groups.
• Three access levels: Super Administrator, Organization Administrator and Guest User.
• Organization plans for managing SMS, email and data retetion.
• Setup alerts.
• Generate scheduled reports.
• Navigation between dashboards and Run Buttons enabled.

Easy Installation

You can quickly install the application in your account by using the Import tool.

• Go to your profile settings.
• Generate an Token in your profile, make sure to set expire time to never.
• Copy the Token.
• Access the Import tool by clicking here.
• Keep all entities selected, paste your token in the account token field.
• Press Import Application and you should receive notification in your account when it's done.

Easy Update

To easy update your application when new version is out, you can just repeat the previous step. If you had made changes to the application, you can choose only the entities you want to update, like only analysis for example.

Step-by-Step installation

You only want to follow this installation method, instead of the easy one, if you plan to have deep understading of how all TagoIO resources works and are used. I can't think of any other reason to go through this method.

• Generate an account-token in your profile settings.
• Create a Custom HTTPs device, to be used as a internal storage for the application. Make sure you have the tag key device_type with tag value settings on it.
• Get Analysis and Dashboard templates from Analysis documentation.
• Create actions as described in the header documentation on each analysis file at Analysis folder.
• Create policies for your Run Users (work in progress)
• Create the Run Buttons (work in progress)
• Follow the Code Setup and Installation instructions below, to make sure scripts are up-to-date.
• You're done!

Code Setup and Installation

Using this repository, you will be able to change and update the analysis in your account. This step is not required unless you plan to make changes in the code.

• Install Node.JS.
• Download the repository.
• Open your terminal and access the folder of the repository.
• Run npm install.
• Generate a account-profile token at TagoIO My Settings -> Your Profile -> Tokens. Make sure to generate a token with Expire at set to never.
• Open the build.ts and replace Your-Account-Profile-Token by a token of your profile.
• Go back to your terminal and run the template with npm start.
• It should take a few minutes for the script to build and import all the analysis and dashboards to your account.

Code Update

• Make sure you have the build.ts with your account profile token.
• Update the repository with last version.
• Go back to your terminal and run the template with npm start.
• It should take a few minutes for the script to build and import all the analysis and dashboards to your account.

How to use the application

The documentation on how to use the application is avaiable to download in the following link analysis-kickstarter/docs/Kickstarter-Guide.

How to learn from this code

You will notice three folders in the src/ folder.

• analysis: contains each analysis that must be present in your account.
• lib: useful list of functions commonly used between the scripts.
• services: services folders that are used in the analysis. Each service is related

For additional informations on how to setup TagoIO with this code, and all the TagoIO resources used, check the Kickstarter Guide documentation at analysis-kickstarter/docs/Kickstarter-Guide.

User Permissions Diagram

graph LR
subgraph TagoIO KickStarter User Permission Diagram V1.0.0
subgraph Guilherme Costa - March 2nd, 2022
    subgraph Application
        subgraph Entities
        Organization(Organization)
        Groups(Groups)
        Sensors(Sensors)
        end
        subgraph Services
        Plan(Plan System)
        Alerts(Alerts)
        Reports(Reports)
        Indicators(System Indicators)
        IndoorView(Indoor & Outdoor Plan)
        end
    end
    style A fill:black,stroke:red,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    A((Administrator))


    A -- Can Invite --> O
    A -- Can Manage --> Organization
    A -- Can Manage --> Groups
    A -- Can Manage --> Sensors
    A -- Can Manage --> Plan
    A -- Can Manage --> Alerts
    A -- Can Manage --> Reports
    A -- Can Manage --> Indicators
    A -- Can Manage --> IndoorView

    linkStyle 0 stroke-width:2px,fill:none,stroke:red;
    linkStyle 1 stroke-width:2px,fill:none,stroke:red;
    linkStyle 2 stroke-width:2px,fill:none,stroke:red;
    linkStyle 3 stroke-width:2px,fill:none,stroke:red;
    linkStyle 4 stroke-width:2px,fill:none,stroke:red;
    linkStyle 5 stroke-width:2px,fill:none,stroke:red;
    linkStyle 6 stroke-width:2px,fill:none,stroke:red;
    linkStyle 7 stroke-width:2px,fill:none,stroke:red;
    linkStyle 8 stroke-width:2px,fill:none,stroke:red;


    style O fill:black,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    O((Organization Admin))
    O -- Can Invite --> G
    O -- Can Manage *1 --> Groups
    O -- Can Manage *1 --> Sensors
    O -- Can Manage *1 --> Alerts
    O -- Can Manage *1 --> Reports
    O -- Can Monitor *1 --> Indicators
    O -- Can Manage *1 --> IndoorView

    linkStyle 9 stroke-width:2px,fill:none,stroke:white;
    linkStyle 10 stroke-width:2px,fill:none,stroke:white;
    linkStyle 11 stroke-width:2px,fill:none,stroke:white;
    linkStyle 12 stroke-width:2px,fill:none,stroke:white;
    linkStyle 13 stroke-width:2px,fill:none,stroke:white;
    linkStyle 14 stroke-width:2px,fill:none,stroke:white;
    linkStyle 15 stroke-width:2px,fill:none,stroke:white;

    style G fill:black,stroke:green,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    G((Guest))
    G -- Can View Only *1 --> Groups
    G -- Can View Only *1 --> Sensors
    G -- Can View Only *1 --> IndoorView
    G -- Will Receive Only *1 --> Reports
    G -- Will Receive Only *1 --> Alerts
    G -- Can Monitor *1 --> Indicators

    linkStyle 16 stroke-width:2px,fill:none,stroke:green;
    linkStyle 17 stroke-width:2px,fill:none,stroke:green;
    linkStyle 18 stroke-width:2px,fill:none,stroke:green;
    linkStyle 19 stroke-width:2px,fill:none,stroke:green;
    linkStyle 20 stroke-width:2px,fill:none,stroke:green;
    linkStyle 21 stroke-width:2px,fill:none,stroke:green;

end
test[1* Only those related to the User's Company]
end

Loading

Support

You can open an issue or question at https://github.com/tago-io/analysis-kickstarter/issues.