# Welcome Welcome to our official LuTango Documentation ## Get Started with LuTango The following guides will help you to get started with LuTango > Having Problems? Please feel free to send us an E-Mail ## IoT Integrations ### Webhook Connect any cloud service to LuTango using Webhooks. ### MQTT ### Node-RED ## LoRaWAN Integrations LuTango features all major LNS. Additional can be connected via Webhook Integration. ### The Things Network Bring your LoRaWAN Devices from [The Things Stack v3](https://www.thethingsnetwork.org/) (both Community or Professional Editions) to LuTango. ### Helium Learn how to connect your [Helium Devices](https://www.helium.com/) to LuTango ### Loriot We do feature a native Integration for the [Loriot.io](https://loriot.io/) LoRaWAN Network Server featuring both Uplinks and Downlinks. # Product ## What is a Product? A product defines the fields in the database, the dashboard, the payload decoders, encoders for downlinks and product-specific settings, such as LoRaWAN network provider or other information concerning integrations. Each device created on Datacake belongs to a Product. Thus, the device inherits the number of fields, the specific downlinks, decoders and other settings during adding or creation. TL;DR. A product defines: * Database Fields * Dashboard * Payload Decoder * Downlinks A device inherits and overrides these settings and/or overwrites (or stores data into the database fields). ### Structure According to the above description, the Product-Device structure in Datacake is as follows:
### What are the benefits of using Products? With a product you define properties that you can apply to all devices that belong to that product. You can consider products as a kind of template that defines the functions, properties and other things. Thus, a product makes it easier to work with devices in large numbers. # Configuration Here is a summary of all possible ways you can configure your devices. ## General Configuration No matter what type of device, each device created can be configured under its general configuration tab. When navigating through the configuration of a device, the first item displayed is the summary of its general settings. ### Icon Apart from being able to change the name, you can set an icon to represent the device. This icon will appear on the map widgets or map view when no role field is selected. ### Tags Here you can assign your own tags to your devices. These help you sort your devices better, as well as to configure map widgets and reports. To setup a tag, just type in the name of the tag on the "Add Tag" field. Click Enter and don't forget to Save the changes! ### Metadata You can use metadata to add your own information to your devices, which does not necessarily have to be stored in a field of the database. You can also use metadata in some widgets on the dashboard, e.g. to create an overview of measured values in a table and colorise this table based on metadata. ### Online Timeout If no further measured values or other messages are transmitted from a device within the time specified here, the device is displayed as offline in the listing and in other places. ### Activate Notifications If you want to get notified when your devices gets Offline, simply activate the Checkbox here and when your Device hasn't received new measurement values within the set time you will receive a notification about this via E-Mail. {% hint style="info" %} This option enables sending offline-alerts for the currently logged in user (you). If you want other users to receive notifications as well - you must instruct them to enable this on their side / account as well. {% endhint %} ### Claiming With the help of Claiming you can move devices between Workspaces or share Devices with other persons like customers, etc. Read more about Claiming here: ## Product Configuration When creating a device you can add it using an existing product or create a new one. When a new product is created it gets a Product Slug, which is the reference name of that product in our backend. You cannot change this name yourself, so once created, the product will always have the same slug. You can also select an icon for a product, which all devices under that product will inherit. ## LoRaWAN/API Configuration The next section depends on the type of device you have added to the platform. Please visit our documentation about how to create a connection to your Network Server for LoRaWAN devices here. If you want to know more about the Serial Number for API devices, you will find it here. ## Payload Decoder ### LoRaWAN devices ### API devices You will find a detailed guide on how to decode your device's payloads in the next article: You will be able to see the incoming messages on the right side button "Show logs". ## MQTT Configuration On API devices after Payload decoders you will see the MQTT configuration section. To learn more about it visit: ## Fields The fields are the measured values of your devices, which get stored in our time-series database. Depending on your subscription plan, a certain number of fields can be created per device. This are also the so-called "datapoints". To learn more about fields visit: To learn more about datapoints and data retention times in our time-series database visit: ## Configuration Fields Configuration Fields allow you to create static variables that exist as a product-wide default and can be overwritten per device. To read more about how to use them visit the next link: ## Danger Zone At the end on the device's configuration you will find the Danger Zone. Be careful with those configurations, since they are critical. You can change the plan or subscription in which your devices are, as well as see how many datapoints they have consumed in the past 24 hours. # Database # Fields ## What is a Field? In the LuTango Cloud the measured values of your devices are stored in "Fields". These are entries in our time-series database. Depending on your subscription plan, a certain number of fields can be created per device. This are also the so-called "datapoints". ## Creating a new Field To create your own field, open any device and navigate to its configuration area using the tab bar. There you scroll down a little until you see the "Fields" panel: Just click on the blue button "Add Field" to create a new field. The following dialog should appear: ## Type We support following field types: ### Integer Stores natural numbers, called in computer science integers, for example, `1234567`. ### Float Stores numbers with decimal places, even floating point, such as `1234.56`. This type is suitable for storing values with fractions, such as * Temperature * Pressure * Air quality ### String Save complete character strings. like `Sensor OK`, `Your own payload information`, `A83B8CFH38420`. These are being stored unprocessed in the database including a timestamp. Use this data type to store e.g.: * status messages * events * Your own payload data In addition, strings can be used in conjunction with mapping fields to convert numeric sensor values into a status via look-up table. ### Boolean Via Boolean fields you can store measured values of digital signals that are either only `0` or `1`, or `True` or `False`. Use these for: * Status-Signals of digital Inputs * True / False conditions * Events ### Geolocation This field type stores geolocation coordinates, which are provided by GPS modules, for example, and can be used to display positions on maps. If you choose to store coordinates using a location field, the field expects you to deliver the data as a string and formatted as follows: ```javascript "(latitude,longitude)" // Structure "(52.0123,4.124521)" // Example ``` ## Name This is the displayed, readable name as it can be used in the portal, e.g. to give widgets on dashboards a title or in other places. {% hint style="success" %} You can change this name at any time later. {% endhint %} ## Identifier The identifier is a unique designation that is used for storing data in the database. {% hint style="warning" %} Once the field is created, the identifier cannot be changed. If you still want to change it, you must delete the field. {% endhint %} ## Unit Use the input field to define the unit of the measured values that are being recorded into that field. Thanks to a free text field, you can define any units here, whether `°C`, `PPM`, `Bar`, `Fahrenheit` or `cake`, `biscuits`, whatever. ### Conversion {% hint style="success" %} You want to convert units into another one? No problem! Use mapping fields for the conversion of your measurement values via scaling, look-up table or linear scaling of a value range. Use Formula Option of a field to do simple mathematical operations. {% endhint %} ## Role The roles assigned allow you to visualise the most important fields of your devices on the list, grid and map views. Learn more about them: ## Formula Each field has the function of a formula. Here, simple mathematical operations can be used to combine measured values from other fields or to perform special calculations. More on this topic is given in the following section: # Data retention & Datapoints ## Data retention & Datapoints ### What is data retention? Data retention refers to the period of time in which datapoints will be stored in our time-series database. #### So how much data retention do I need? Depending on the application, you may need to collect data for the next few months, or only data from the last few days. The database will begin to gradually discard the data. This means, that once the established data retention period is reached, the oldest packets will be dropped to make room for new packets received. ### What are datapoints? The datapoints are the measured values of your devices that gets stored as field entries into the LuTango database. Depending on your subscription plan, a certain number of fields or datapoints can be created per device. This means, that depending on the subscription, the devices will be allowed to store within the created fields a maximum amount of collected data, after which they will start dropping packages. This will lead to a delay in the display of new data on the interface. #### So how many datapoints do I need? That depends on your specific use case. Please take into account the amount of data your sensors will transmit, how often and in how many fields this information will be divided. We recommend that you review this before you start transmitting data. Below are the datapoints and data retention available per data subscription plan. | Free | Light | Standard | Plus | | --------------------- | ---------------------- | ----------------------- | ------------------------ | | 7 days data retention | 1 month data retention | 3 months data retention | 12 months data retention | | 500 datapoints/day | 1000 datapoints/day | 2500 datapoints/day | 7500 datapoints/day | # Dashboards # Global Dashboards # Device Dashboards # Widgets ## Widgets # Value Widget # Chart Widget # Image Map # Map Widget # Portal # Multi-Tenancy (Workspaces) # Members # Api Keys # White Label # Node Red # MQTT