Receiving Actions

3min
This guide shows you how to receive Actions﻿ (Commands) from the Cloud and execute them.
Let us have a look at how to create a "reboot" action that restarts the device. 
To do this we need to first register this action with uplink using its configuration file config.toml. If you have followed the guide this file will be present in /usr/local/share/bytebeam folder. 
Edit this file to add the line actions=[{name="reboot"}] under [tcpapps.1] section.
config.toml
persistence_path = "/tmp/uplink"
action_redirections={update_firmware="install_firmware"}
[tcpapps.1]
port=5050
actions=[{name="reboot"}]

[downloader]
path="/tmp/uplink/download"
actions=[{name="update_firmware", timeout=610}, {name="send_file"}]

[apis]
enabled=true
port=3333

[ota_installer]
path="/tmp/uplink/installer"
actions=[{name="install_firmware", timeout=610}]
uplink_port=5050

[logging]
tags=["sshd", "systemd"]
stream_size=1
min_level=7
persistence_path = "/tmp/uplink"
action_redirections={update_firmware="install_firmware"}
[tcpapps.1]
port=5050
actions=[{name="reboot"}]

[downloader]
path="/tmp/uplink/download"
actions=[{name="update_firmware", timeout=610}, {name="send_file"}]

[apis]
enabled=true
port=3333

[ota_installer]
path="/tmp/uplink/installer"
actions=[{name="install_firmware", timeout=610}]
uplink_port=5050

[logging]
tags=["sshd", "systemd"]
stream_size=1
min_level=7
﻿
Restart the uplink using the following commands
Shell
sudo systemctl restart uplink
sudo systemctl restart uplink
﻿
﻿
Create a new action type called "Reboot" by following the Creating new Action Types﻿ guide:
﻿
The reboot action should now be visible on the device management page.
﻿
Do not trigger the action yet. We need to first integrate the action into our application. Below you can find a sample application code for receiving actions. 
﻿
demo.py
demo.js
demo.rs
demo.go
package main

import (
	"encoding/json"
	"fmt"
	"net"
	"os"
	"os/exec"
	"strconv"
	"time"
)

func main() {
	conn, err := net.Dial("tcp", "localhost:5050")
	if err != nil {
			fmt.Println("Error connecting:", err.Error())
			os.Exit(1)
	}

	// Start a goroutine for receiving actions
	go receiveActions(conn)

	fmt.Println("Starting Uplink Bridge App")
}

// receiveAction reads and decodes JSON data from the connection
func receiveAction(conn net.Conn) map[string]interface{} {
	buffer := make([]byte, 2048)
	length, _ := conn.Read(buffer)
	var data map[string]interface{}
	json.Unmarshal(buffer[:length], &data)
	return data
}

// sendData encodes the payload to JSON and sends it over the connection
func sendData(conn net.Conn, payload map[string]interface{}) {
	send, _ := json.Marshal(payload)
	conn.Write(append(send, '\n'))
}

// actionComplete constructs a JSON action_status response
func actionComplete(id interface{}) map[string]interface{} {
	return map[string]interface{}{
			"stream":    "action_status",
			"sequence":  0,
			"timestamp": time.Now().UnixNano() / int64(time.Microsecond),
			"action_id": id,
			"state":     "Completed",
			"progress":  100,
			"errors":    []string{},
	}
}

// reboot performs a system reboot
func reboot(action map[string]interface{}) {
	payload := action["payload"].(map[string]interface{})
	fmt.Println(payload)
	resp := actionComplete(action["action_id"])
	fmt.Println(resp)
	sendData(conn, resp)
	cmd := exec.Command("sudo", "reboot")
	cmd.Run()
}

// receiveActions listens for actions and processes them
func receiveActions(conn net.Conn) {
	for {
			action := receiveAction(conn)
			fmt.Println(action)

			if action["name"] == "reboot" {
					fmt.Println("reboot action received")
					reboot(action)
			}
	}
}
package main

import (
	"encoding/json"
	"fmt"
	"net"
	"os"
	"os/exec"
	"strconv"
	"time"
)

func main() {
	conn, err := net.Dial("tcp", "localhost:5050")
	if err != nil {
			fmt.Println("Error connecting:", err.Error())
			os.Exit(1)
	}

	// Start a goroutine for receiving actions
	go receiveActions(conn)

	fmt.Println("Starting Uplink Bridge App")
}

// receiveAction reads and decodes JSON data from the connection
func receiveAction(conn net.Conn) map[string]interface{} {
	buffer := make([]byte, 2048)
	length, _ := conn.Read(buffer)
	var data map[string]interface{}
	json.Unmarshal(buffer[:length], &data)
	return data
}

// sendData encodes the payload to JSON and sends it over the connection
func sendData(conn net.Conn, payload map[string]interface{}) {
	send, _ := json.Marshal(payload)
	conn.Write(append(send, '\n'))
}

// actionComplete constructs a JSON action_status response
func actionComplete(id interface{}) map[string]interface{} {
	return map[string]interface{}{
			"stream":    "action_status",
			"sequence":  0,
			"timestamp": time.Now().UnixNano() / int64(time.Microsecond),
			"action_id": id,
			"state":     "Completed",
			"progress":  100,
			"errors":    []string{},
	}
}

// reboot performs a system reboot
func reboot(action map[string]interface{}) {
	payload := action["payload"].(map[string]interface{})
	fmt.Println(payload)
	resp := actionComplete(action["action_id"])
	fmt.Println(resp)
	sendData(conn, resp)
	cmd := exec.Command("sudo", "reboot")
	cmd.Run()
}

// receiveActions listens for actions and processes them
func receiveActions(conn net.Conn) {
	for {
			action := receiveAction(conn)
			fmt.Println(action)

			if action["name"] == "reboot" {
					fmt.Println("reboot action received")
					reboot(action)
			}
	}
}
﻿
Once your app has been modified and is running, you can go to Bytebeam Cloud and click on the Reboot action button to trigger the action. Next, you will see the following message
﻿
Click on Yes. Next, on the action panel, you can monitor the status of your last triggered action
﻿
After completion of an action, the Action Status changes to Completed, and you should see your device reboot
﻿
﻿
﻿
Updated 23 Nov 2023
Did this page help you?
Customising device shadow
Remote login to your Linux device