Skip to main content
Documentation Hub

Node Sharing

about

ESP RainMaker enables users to control a node remotely over the Internet. However, there are often situations where others also need access to the same node. For example, you may want to grant family members control over smart light bulbs, temporarily provide a tenant or maid access to a door lock, or allow multiple employees to remotely access a shared hardware resource. To accommodate such use cases, ESP RainMaker offers the ability to share a node with others.

User Roles​

Node sharing introduces the concept of "User Roles." In this section, we specifically refer to end users and their different roles: Primary User and Secondary User. To learn more about these roles and their differences, please refer to the previous section.

Workflow of User-Node mapping​

Sharing Node(s)​

  1. Primary User registers a request with the ESP RainMaker cloud to share nod(s) with a secondary user.
  2. The user with whom the node is to be shared can list the request(s) it has received and accept/decline, as required.
  3. Primary user can also list the request(s) it has initiated by passing the primary user flag and cancel them if required.
  4. Once a request is accepted/declined/cancelled, it will not show up in the list of requests.
info
  • The pending request(s) are valid for 7 days and are automatically deleted if the request is not accepted/declined/cancelled.
  • Secondary users cannot further share the node(s). Only primary users can do so.
tip

Once a node is shared, it can be used directly from the secondary user's phone app.

Removing Shared Node(s)​

Primary user can remove the secondary user from the shared node(s) anytime and the node(s) will no longer be shared with the secondary user.

info
  • If a primary user removes its own association with a node which has multiple primary users, then it won't affect the association of the node with the other users.
  • If the 'only' primary user removes its own association with a node, then all secondary users are removed automatically.
  • If secondary user removes its own association with a shared node, it won't affect the association of the node with the other users.
  • If a new user gets associated with a node (via provisioning), then all previous primary user(s) and secondary user(s) it had shared the node with, will be removed. The new user becomes the primary user for the node.

Viewing Node Sharing Details​

  • User (Primary or Secondary) can list sharing details of the node(s) it is associated with.
  • For each node, the sharing details include the node id, primary user and secondary user(s) of that node.

Usage Guide​

To try out the node sharing feature of ESP RainMaker, there are two ways to do so.

  • Using Phone Apps
  • Using ESP RainMaker CLI

Using Phone Apps​

Easiest way to use node sharing is via the ESP RainMaker Phone apps.

Using ESP RainMaker CLI​

To learn how to use node sharing feature on ESP RainMaker CLI, please click here

API​

To know more about the API's, you can refer to the documentation here.

On this page