Editing an Action Type

To edit the existing action type in Bytebeam console,

1. Access Actions Tab

   Click on the Actions tab at the top

2. Go to Action Settings Tab and Initiate Action Type Edit

   Navigate to the Action Settings tab and click on the edit icon against the target action type

3. Fill Details

   Select the payload, icon and the timeout duration and click on Submit button to edit the action type.

Only timeout duration can be changed for default action types like update_firmware, update_config etc.

Payload for Action Types

There are 3 payload options in 4 variations available while editing the action type.

None

You can choose this for action types like Shutdown which don’t need any payload to be sent to the device while triggering the action.

JSON

You can choose this for action types which need the JSON payload to be sent to the device while triggering the action.

JSON Data via form

You can choose this for action types like Update CAN Config, which enables JSON data to be sent via a form to the device while triggering the action.

To choose this option:

1. Select JSON from the dropdown.
2. Enable the Allow user to input data via form toggle.
3. Enter the JSON Schema along with the JSON UI Schema while creating or editing the action type.

JSON Schema Example

{
  "title": "",
  "type": "object",
  "required": [
    "can_bitrate",
    "can_filter_mask",
    "data_frequencies"
  ],
  "properties": {
    "can_bitrate": {
      "type": "string",
      "title": "CAN BitRate (kbps)",
      "default": "500"
    },
    "can_filter_mask": {
      "type": "string",
      "title": "CAN Filter Mask",
      "default": "0x00"
    },
    "data_frequencies": {
      "type": "array",
      "title": "Data Frequencies",
      "items": {
        "type": "object",
        "required": [
          "can_mask",
          "frequency"
        ],
        "properties": {
          "can_mask": {
            "type": "string",
            "title": "CAN Mask"
          },
          "frequency": {
            "type": "string",
            "title": "Frequency (Hz)"
          }
        }
      }
    }
  }
}

{
  "title": "",
  "type": "object",
  "required": [
    "can_bitrate",
    "can_filter_mask",
    "data_frequencies"
  ],
  "properties": {
    "can_bitrate": {
      "type": "string",
      "title": "CAN BitRate (kbps)",
      "default": "500"
    },
    "can_filter_mask": {
      "type": "string",
      "title": "CAN Filter Mask",
      "default": "0x00"
    },
    "data_frequencies": {
      "type": "array",
      "title": "Data Frequencies",
      "items": {
        "type": "object",
        "required": [
          "can_mask",
          "frequency"
        ],
        "properties": {
          "can_mask": {
            "type": "string",
            "title": "CAN Mask"
          },
          "frequency": {
            "type": "string",
            "title": "Frequency (Hz)"
          }
        }
      }
    }
  }
}

{
  "can_bitrate": {
    "ui:placeholder": "Eg: 250"
  },
  "can_filter_mask": {
    "ui:placeholder": "Eg: 0xffD",
    "ui:emptyValue": ""
  },
  "data_frequencies": {
    "ui:options": {
      "orderable": false,
      "inline": true
    },
    "items": {
      "can_mask": {
        "ui:inline": true,
        "ui:placeholder": "Eg: 0x7ff"
      },
      "frequency": {
        "ui:inline": true,
        "ui:placeholder": "Eg: 100"
      }
    }
  }
}

When the above configuration is used while editing the action type, it appears like this when triggering the action:

Text

You can choose this for action types which need the payload in text format to be sent to the device while triggering the action.

Assistant

Responses are generated using AI and may contain mistakes.