Integrate Config Updates

5min
Bytebeam enables you to remotely change the configuration of your application. This is done by sending JSON-based configuration to the device. This guide will walk you through how to achieve this. 
Creating new device config.
Steps to update configuration:
Step 1: Go to the device management section in Bytebeam cloud.
Step 2: Go to the "Device Configs" section
﻿
Step 3: Click on "New Device Config"
﻿
Step 4: Enter the appropriate details for the device configuration. In this example, We are changing the current log level of our Python application
﻿
﻿
The new device config should be visible now.
﻿
On the device, First, register this action with uplink using its configuration file config.toml as we did in the Receiving Actions section. This file is present in /usr/local/share/bytebeam folder.
Edit this file to add the line actions=[{name="update_config"}] under [tcpapps.1] section.
config.toml
persistence_path = "/tmp/uplink"
action_redirections={update_firmware="install_firmware"}
[tcpapps.1]
port=5050
actions=[{name="reboot"}, {name="update_config"}]

[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"}, {name="update_config"}]

[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
﻿
Next using the following example you can update the configuration on your device
Python
Javascript
Rust
Go
package main

import (
    "bufio"
    "encoding/json"
    "fmt"
    "io"
    "net"
    "os"
    "time"

    log "github.com/sirupsen/logrus"
)

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

    log.SetLevel(log.InfoLevel)
    log.SetFormatter(&log.TextFormatter{})
    log.SetOutput(os.Stdout)

    go receiveActions(conn)

    fmt.Println("Starting Uplink Bridge App")
    for {
        time.Sleep(5 * time.Second)
        log.Debug("This is debug")
        log.Info("This is info")
        log.Error("This is error")
    }
}

// receiveAction reads and decodes a JSON message from the connection.
func receiveAction(conn net.Conn) (map[string]interface{}, error) {
    reader := bufio.NewReader(conn)
    msg, err := reader.ReadString('\n')
    if err != nil {
        return nil, err
    }

    var action map[string]interface{}
    err = json.Unmarshal([]byte(msg), &action)
    return action, err
}

// sendAction encodes a payload as JSON and sends it over the connection.
func sendAction(conn net.Conn, payload map[string]interface{}) error {
    msg, err := json.Marshal(payload)
    if err != nil {
        return err
    }
    _, err = conn.Write(append(msg, '\n'))
    return err
}

// actionComplete constructs a JSON `action_status` as a response to received action on completion.
func actionComplete(id interface{}) map[string]interface{} {
    return map[string]interface{}{
        "stream":    "action_status",
        "sequence":  0,
        "timestamp": time.Now().UnixNano() / 1000,
        "action_id": id,
        "state":     "Completed",
        "progress":  100,
        "errors":    []string{},
    }
}

// updateConfig processes the update_config action.
func updateConfig(conn net.Conn, action map[string]interface{}) {
    payloadStr := action["payload"].(string)
    var payload map[string]interface{}
    json.Unmarshal([]byte(payloadStr), &payload)

    app := payload["name"].(string)
    level := payload["level"].(string)
    if app == "logging" {
        setLogLevel(level)
    }

    resp := actionComplete(action["action_id"])
    sendAction(conn, resp)
}

func setLogLevel(level string) {
    switch level {
    case "info":
        log.SetLevel(log.InfoLevel)
    case "error":
        log.SetLevel(log.ErrorLevel)
    case "verbose":
        log.SetLevel(log.TraceLevel) // Go's logrus doesn't have 'verbose', using 'Trace' instead
    case "debug":
        log.SetLevel(log.DebugLevel)
    default:
        log.SetLevel(log.InfoLevel)
    }
    log.Infof("Log level set to %s", level)
}

// recvActions handles incoming actions in a separate goroutine.
func receiveActions(conn net.Conn) {
    for {
        action, err := receiveAction(conn)
        if err != nil {
            if err == io.EOF {
                fmt.Println("Connection closed by server")
                return
            }
            fmt.Println("Error reading:", err)
            continue
        }
        fmt.Println("Action received:", action)

        if action["name"] == "update_config" {
            fmt.Println("update_config action received")
            updateConfig(conn, action)
        }
    }
}

package main

import (
    "bufio"
    "encoding/json"
    "fmt"
    "io"
    "net"
    "os"
    "time"

    log "github.com/sirupsen/logrus"
)

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

    log.SetLevel(log.InfoLevel)
    log.SetFormatter(&log.TextFormatter{})
    log.SetOutput(os.Stdout)

    go receiveActions(conn)

    fmt.Println("Starting Uplink Bridge App")
    for {
        time.Sleep(5 * time.Second)
        log.Debug("This is debug")
        log.Info("This is info")
        log.Error("This is error")
    }
}

// receiveAction reads and decodes a JSON message from the connection.
func receiveAction(conn net.Conn) (map[string]interface{}, error) {
    reader := bufio.NewReader(conn)
    msg, err := reader.ReadString('\n')
    if err != nil {
        return nil, err
    }

    var action map[string]interface{}
    err = json.Unmarshal([]byte(msg), &action)
    return action, err
}

// sendAction encodes a payload as JSON and sends it over the connection.
func sendAction(conn net.Conn, payload map[string]interface{}) error {
    msg, err := json.Marshal(payload)
    if err != nil {
        return err
    }
    _, err = conn.Write(append(msg, '\n'))
    return err
}

// actionComplete constructs a JSON `action_status` as a response to received action on completion.
func actionComplete(id interface{}) map[string]interface{} {
    return map[string]interface{}{
        "stream":    "action_status",
        "sequence":  0,
        "timestamp": time.Now().UnixNano() / 1000,
        "action_id": id,
        "state":     "Completed",
        "progress":  100,
        "errors":    []string{},
    }
}

// updateConfig processes the update_config action.
func updateConfig(conn net.Conn, action map[string]interface{}) {
    payloadStr := action["payload"].(string)
    var payload map[string]interface{}
    json.Unmarshal([]byte(payloadStr), &payload)

    app := payload["name"].(string)
    level := payload["level"].(string)
    if app == "logging" {
        setLogLevel(level)
    }

    resp := actionComplete(action["action_id"])
    sendAction(conn, resp)
}

func setLogLevel(level string) {
    switch level {
    case "info":
        log.SetLevel(log.InfoLevel)
    case "error":
        log.SetLevel(log.ErrorLevel)
    case "verbose":
        log.SetLevel(log.TraceLevel) // Go's logrus doesn't have 'verbose', using 'Trace' instead
    case "debug":
        log.SetLevel(log.DebugLevel)
    default:
        log.SetLevel(log.InfoLevel)
    }
    log.Infof("Log level set to %s", level)
}

// recvActions handles incoming actions in a separate goroutine.
func receiveActions(conn net.Conn) {
    for {
        action, err := receiveAction(conn)
        if err != nil {
            if err == io.EOF {
                fmt.Println("Connection closed by server")
                return
            }
            fmt.Println("Error reading:", err)
            continue
        }
        fmt.Println("Action received:", action)

        if action["name"] == "update_config" {
            fmt.Println("update_config action received")
            updateConfig(conn, action)
        }
    }
}
﻿
﻿
Triggering config update
On the device management section of Bytebeam Cloud, select the device and click on Update Configuration
﻿
﻿
Select the appropriate config. version.
﻿
Confirm the selection.
﻿
You should now be able to see the status of the update on the cloud.
﻿
﻿
﻿
Updated 23 Nov 2023
Did this page help you?
Rootfs Update
Push application logs