RTLS Kickstarter Application for TagoIO

This is a starter application to be used with TagoIO. It includes the main required features for a regular application to run, with 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 its foundations.

Components

The application contains the following features:

• Two levels: Organization and Sites
• Three access levels: Application Administrator, Organization Administrator, and End User
• Setup alerts
• Generate reports
• Navigation between dashboards and Run sidebar buttons

Easy Installation

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

• First, make sure your RUN is activated. Visit this link, click on "Start now", and then save the change.
• Go to your profile settings.
• Generate a Token in your profile, making sure to set the 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.
• Select your region.
• Press Import Application, and you should receive a notification in your account when it's completed.
• To access the application using TagoRUN, make sure to create a user using your TagoIO Developer account, adding the tag key access with the tag value admin.

Easy Update

To easily update your application when a new version is available, you can repeat the previous step. If you have made changes to the application, you can choose only the entities you want to update, such as only the analysis.

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 to the code.

• Install Node.JS.
• Download the repository.
• Open your terminal and access the folder of the repository.
• Run npm install.
• Generate an account-profile token at TagoIO My Settings -> Your Profile -> Tokens. Make sure to generate a token with Expire at set to never, or utilize the TagoIO CLI to deploy your scripts.
• Open the build.ts and replace Your-Account-Profile-Token with a token from your profile.
• Go back to your terminal and run the template with npm run start build.
• 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 the latest version.
• Go back to your terminal and run the template with npm run start build.
• It should take a few minutes for the script to build and import all the analysis and dashboards to your account.

Key Dependencies

• @tago-io/sdk: TagoIO SDK for interacting with the platform
• axios: For making HTTP requests
• geolib: For geolocation calculations
• luxon: For date/time handling
• zod: For runtime type checking

How to Learn from This Code

The source code is organized in the following structure:

• src/analysis: Contains the analysis scripts
• src/lib: Common utility functions
• src/services: Service-specific implementations
• src/types.ts: TypeScript type definitions

Each service is related to specific functionality within the application. The analysis folder contains each analysis that must be present in your account, while the lib folder contains useful functions commonly used between the scripts.

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

User Permissions Diagram

graph LR
subgraph User Permission Diagram V1.0.0
    subgraph Application
        subgraph Entities
            Organization(Organizations)
            Sites(Sites)
            Devices(Devices)
            Equipment(Equipment)
        end
    end
    
    style SA fill:black,stroke:purple,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    SA((Super Admin))
    
    SA -- Can Manage All --> Organization
    SA -- Can Manage All --> Sites
    SA -- Can Manage All --> Devices
    SA -- Can Manage All --> Equipment
    SA -- Can Create --> A
    SA -- Can Create --> E
    
    linkStyle 0 stroke-width:2px,fill:none,stroke:purple;
    linkStyle 1 stroke-width:2px,fill:none,stroke:purple;
    linkStyle 2 stroke-width:2px,fill:none,stroke:purple;
    linkStyle 3 stroke-width:2px,fill:none,stroke:purple;
    linkStyle 4 stroke-width:2px,fill:none,stroke:purple;
    linkStyle 5 stroke-width:2px,fill:none,stroke:purple;
    
    style A fill:black,stroke:red,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    A((Admin))
    
    A -- Can Manage *1 --> Organization
    A -- Can Manage *1 --> Sites
    A -- Can Manage *1 --> Devices
    A -- Can Manage *1 --> Equipment
    A -- Can Create --> E
    
    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;
    linkStyle 9 stroke-width:2px,fill:none,stroke:red;
    linkStyle 10 stroke-width:2px,fill:none,stroke:red;
    
    style E fill:black,stroke:green,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
    E((End User))
    
    E -- Can View Only *2 --> Sites
    E -- Can View Only *2 --> Devices
    E -- Can View Only *2 --> Equipment
    
    linkStyle 11 stroke-width:2px,fill:none,stroke:green;
    linkStyle 12 stroke-width:2px,fill:none,stroke:green;
    linkStyle 13 stroke-width:2px,fill:none,stroke:green;
    
    subgraph Hierarchy
        Organization --> Sites
        Sites --> Devices
        Devices --> Equipment
    end
    
    note1[*1 Only within their assigned Organization]
    note2[*2 Only within their assigned Site]
end

Loading

Support

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