Arduino

Connects to and controls an Arduino pin system using the network.

Utilities · Arduino

Details

IDArduino
ProviderQualcomm
CategoryUtilities
From Version6.0.0
Docker Imagedemisto/python3:3.12.8.3296088
Supported ModulesAgentix XSIAM

README

Connects to and controls an Arduino pin system using the network.

Configure Arduino in Cortex

Parameter Description Required
Hostname or IP Hostname or IP True
Port number Port number True

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

arduino-set-pin


Requests that a pin be set

Base Command

arduino-set-pin

Input

Argument Name Description Required
pin_type The type of pin. Possible values are: digital, analog. Default is digital. Required
pin_number The pin number to set. Required
value The value to set the pin to. Required
host Host name / IP address (optional - overrides parameters). Optional
port Port number (optional - overrides parameters). Optional

Context Output

Path Type Description
Arduino.DigitalPins unknown Digital Pins
Arduino.DigitalPins.PinNumber number PinNumber
Arduino.DigitalPins.PinType string Pin Type
Arduino.DigitalPins.PinValue number Pin Value
Arduino.AnalogPins unknown Analog Pins
Arduino.AnalogPins.PinNumber number PinNumber
Arduino.AnalogPins.PinType string Pin Type
Arduino.AnalogPins.PinValue number Pin Value

arduino-get-pin


Requests the value of a pin

Base Command

arduino-get-pin

Input

Argument Name Description Required
pin_type Pin type. Possible values are: digital, analog. Default is digital. Required
pin_number The pin to read the value from. Required
host Host name / IP address (optional - overrides parameters). Optional
port Port number (optional - overrides parameters). Optional

Context Output

Path Type Description
Arduino.DigitalPins unknown Digital Pins
Arduino.DigitalPins.PinNumber number PinNumber
Arduino.DigitalPins.PinType string Pin Type
Arduino.DigitalPins.PinValue number Pin Value
Arduino.AnalogPins unknown Analog Pins
Arduino.AnalogPins.PinNumber number PinNumber
Arduino.AnalogPins.PinType string Pin Type
Arduino.AnalogPins.PinValue number Pin Value

arduino-send-data


Send arbitrary data to the Arduino

Base Command

arduino-send-data

Input

Argument Name Description Required
data The data to send. Required
host Host name / IP address (optional - overrides parameters). Optional
port Port number (optional - overrides parameters). Optional

Context Output

Path Type Description
Arduino.DataSend unknown Data Send
Arduino.DataSend.Sent string The data sent
Arduino.DataSend.Received string The data received

Configuration parameters

  • host — Hostname or IP (required)
  • port — Port number (required)

Commands (3)

  • arduino-get-pin

    Requests the value of a pin

  • arduino-send-data

    Send arbitrary data to the Arduino

  • arduino-set-pin

    Requests that a pin be set

category: Utilities
provider: Qualcomm
commonfields:
  id: Arduino
  version: -1
configuration:
- additionalinfo: Hostname or IP
  display: Hostname or IP
  name: host
  required: true
  type: 0
- additionalinfo: Port number
  defaultvalue: '9090'
  display: Port number
  name: port
  required: true
  type: 0
description: Connects to and controls an Arduino pin system using the network.
display: Arduino
name: Arduino
script:
  commands:
  - arguments:
    - auto: PREDEFINED
      defaultValue: digital
      description: The type of pin.
      name: pin_type
      predefined:
      - digital
      - analog
      required: true
    - description: The pin number to set.
      name: pin_number
      required: true
    - description: The value to set the pin to.
      name: value
      required: true
    - description: Host name / IP address (optional - overrides parameters).
      name: host
    - description: Port number (optional - overrides parameters).
      name: port
    description: Requests that a pin be set
    name: arduino-set-pin
    outputs:
    - contextPath: Arduino.DigitalPins
      description: Digital Pins.
    - contextPath: Arduino.DigitalPins.PinNumber
      description: PinNumber.
      type: number
    - contextPath: Arduino.DigitalPins.PinType
      description: Pin Type.
      type: string
    - contextPath: Arduino.DigitalPins.PinValue
      description: Pin Value.
      type: number
    - contextPath: Arduino.AnalogPins
      description: Analog Pins.
    - contextPath: Arduino.AnalogPins.PinNumber
      description: PinNumber.
      type: number
    - contextPath: Arduino.AnalogPins.PinType
      description: Pin Type.
      type: string
    - contextPath: Arduino.AnalogPins.PinValue
      description: Pin Value.
      type: number
  - arguments:
    - auto: PREDEFINED
      defaultValue: digital
      description: Pin type.
      name: pin_type
      predefined:
      - digital
      - analog
      required: true
    - description: The pin to read the value from.
      name: pin_number
      required: true
    - description: Host name / IP address (optional - overrides parameters).
      name: host
    - description: Port number (optional - overrides parameters).
      name: port
    description: Requests the value of a pin
    name: arduino-get-pin
    outputs:
    - contextPath: Arduino.DigitalPins
      description: Digital Pins.
    - contextPath: Arduino.DigitalPins.PinNumber
      description: PinNumber.
      type: number
    - contextPath: Arduino.DigitalPins.PinType
      description: Pin Type.
      type: string
    - contextPath: Arduino.DigitalPins.PinValue
      description: Pin Value.
      type: number
    - contextPath: Arduino.AnalogPins
      description: Analog Pins.
    - contextPath: Arduino.AnalogPins.PinNumber
      description: PinNumber.
      type: number
    - contextPath: Arduino.AnalogPins.PinType
      description: Pin Type.
      type: string
    - contextPath: Arduino.AnalogPins.PinValue
      description: Pin Value.
      type: number
  - arguments:
    - description: The data to send.
      name: data
      required: true
    - description: Host name / IP address (optional - overrides parameters).
      name: host
    - description: Port number (optional - overrides parameters).
      name: port
    description: Send arbitrary data to the Arduino
    name: arduino-send-data
    outputs:
    - contextPath: Arduino.DataSend
      description: Data Send.
    - contextPath: Arduino.DataSend.Sent
      description: The data sent.
      type: string
    - contextPath: Arduino.DataSend.Received
      description: The data received.
      type: string
  dockerimage: demisto/python3:3.12.8.3296088
  script: ''
  subtype: python3
  type: python
fromversion: 6.0.0
tests:
- No tests (auto formatted)