Board config schema

$schema: http://json-schema.org/draft-07/schema#

$ref: #/definitions/BoardConfig

definitions

BoardConfig

• Board config

• Type: object
• path: #/definitions/BoardConfig
• This schema does not accept additional properties.
• Properties
  • deviceName required
    • Name of the device
    • Type: string
    • path: #/definitions/BoardConfig/properties/deviceName
    • Length: ≤ 32
  • ledChargingGpio
    • Charging led gpio number
    • Type: integer
    • path: #/definitions/BoardConfig/properties/ledChargingGpio
  • ledErrorGpio
    • Error led gpio number
    • Type: integer
    • path: #/definitions/BoardConfig/properties/ledErrorGpio
  • ledWifiGpio
    • WiFi led gpio number
    • Type: integer
    • path: #/definitions/BoardConfig/properties/ledWifiGpio
  • buttonGpio
    • Button gpio number
    • Type: integer
    • path: #/definitions/BoardConfig/properties/buttonGpio
  • pilot required
    • path: #/definitions/BoardConfig/properties/pilot
    • $ref: #/definitions/Pilot
  • proximity
    • path: #/definitions/BoardConfig/properties/proximity
    • $ref: #/definitions/Proximity
  • acRelayGpio required
    • AC relay gpio number for controlling mains contactor
    • Type: integer
    • path: #/definitions/BoardConfig/properties/acRelayGpio
  • socketLock
    • path: #/definitions/BoardConfig/properties/socketLock
    • $ref: #/definitions/SocketLock
  • rcm
    • path: #/definitions/BoardConfig/properties/rcm
    • $ref: #/definitions/Rcm
  • energyMeter
    • path: #/definitions/BoardConfig/properties/energyMeter
    • $ref: #/definitions/EnergyMeter
  • auxInputs
    • Aux inputs configuration
    • Type: array
    • path: #/definitions/BoardConfig/properties/auxInputs
      • Items
      • path: #/definitions/BoardConfig/properties/auxInputs/items
      • $ref: #/definitions/AuxInput
  • auxOutputs
    • Aux outputs configuration
    • Type: array
    • path: #/definitions/BoardConfig/properties/auxOutputs
      • Items
      • path: #/definitions/BoardConfig/properties/auxOutputs/items
      • $ref: #/definitions/AuxOutput
  • auxAnalogInputs
    • Aux analog inputs configuration
    • Type: array
    • path: #/definitions/BoardConfig/properties/auxAnalogInputs
      • Items
      • path: #/definitions/BoardConfig/properties/auxAnalogInputs/items
      • $ref: #/definitions/AuxAnalogInput
  • serials
    • Serial ports configuration
    • Type: array
    • path: #/definitions/BoardConfig/properties/serials
    • Item Count: ≤ 3
      • Items
      • path: #/definitions/BoardConfig/properties/serials/items
      • $ref: #/definitions/Serial
  • onewire
    • path: #/definitions/BoardConfig/properties/onewire
    • $ref: #/definitions/Onewire

EnergyMeter

• EnergyMeter

• Energy meter configuration
• Type: object
• path: #/definitions/EnergyMeter
• This schema does not accept additional properties.
• Properties
  • currentAdcChannels required
    • Current sensing of L1, L2, L3 adc1 channels, for single phase set array with one item
    • Type: array
    • path: #/definitions/EnergyMeter/properties/currentAdcChannels
    • Item Count: ≤ 3
      • Items
      • Type: integer
      • path: #/definitions/EnergyMeter/properties/currentAdcChannels/items
  • currentScale required
    • Multiplier of measured current values
    • Type: number
    • path: #/definitions/EnergyMeter/properties/currentScale
  • voltageAdcChannels
    • Voltage sensing of L1, L2, L3 adc1 channels, for single phase set array with one item
    • Type: array
    • path: #/definitions/EnergyMeter/properties/voltageAdcChannels
    • Item Count: ≤ 3
      • Items
      • Type: integer
      • path: #/definitions/EnergyMeter/properties/voltageAdcChannels/items
  • voltageScale
    • Multiplier of measured voltage values
    • Type: number
    • path: #/definitions/EnergyMeter/properties/voltageScale

Pilot

• Pilot

• Control pilot configuration
• Type: object
• path: #/definitions/Pilot
• This schema does not accept additional properties.
• Properties
  • gpio required
    • Generating pwm gpio number
    • Type: integer
    • path: #/definitions/Pilot/properties/gpio
  • adcChannel required
    • Measuring adc1 channel
    • Type: integer
    • path: #/definitions/Pilot/properties/adcChannel
  • levels required
    • Measured threshold values for voltages 12, 9, 6, 3 -12 in mV
    • Type: array
    • path: #/definitions/Pilot/properties/levels
    • Item Count: between 5 and 5
      • Items
      • Type: integer
      • path: #/definitions/Pilot/properties/levels/items

Proximity

• Proximity

• Proximity pilot configuration
• Type: object
• path: #/definitions/Proximity
• This schema does not accept additional properties.
• Properties
  • adcChannel required
    • Measuring adc1 channel
    • Type: integer
    • path: #/definitions/Proximity/properties/adcChannel
  • levels required
    • Measured threshold values for cable 13A, 20A, 32A in mV
    • Type: array
    • path: #/definitions/Proximity/properties/levels
    • Item Count: between 3 and 3
      • Items
      • Type: integer
      • path: #/definitions/Proximity/properties/levels/items

SocketLock

• SocketLock

• Socket lock configuration
• Type: object
• path: #/definitions/SocketLock
• This schema does not accept additional properties.
• Properties
  • aGpio required
    • Lock A gpio number
    • Type: integer
    • path: #/definitions/SocketLock/properties/aGpio
  • bGpio required
    • Lock B gpio number
    • Type: integer
    • path: #/definitions/SocketLock/properties/bGpio
  • detectionGpio required
    • Detection gpio number
    • Type: integer
    • path: #/definitions/SocketLock/properties/detectionGpio
  • detectionDelay required
    • Delay after locking/unlocking for check state in ms
    • Type: integer
    • path: #/definitions/SocketLock/properties/detectionDelay
  • minBreakTime required
    • Min break time for repeated locking/unlocking in ms
    • Type: integer
    • path: #/definitions/SocketLock/properties/minBreakTime

Rcm

• Rcm

• Residual current monitor configuration
• Type: object
• path: #/definitions/Rcm
• This schema does not accept additional properties.
• Properties
  • gpio required
    • Sensing gpio number
    • Type: integer
    • path: #/definitions/Rcm/properties/gpio
  • testGpio required
    • Test gpio number
    • Type: integer
    • path: #/definitions/Rcm/properties/testGpio

AuxInput

• Aux input

• Aux input configuration
• Type: object
• path: #/definitions/AuxInput
• This schema does not accept additional properties.
• Properties
  • name required
    • Name
    • Type: string
    • path: #/definitions/AuxInput/properties/name
    • Length: ≤ 8
  • gpio required
    • The gpio number
    • Type: integer
    • path: #/definitions/AuxInput/properties/gpio

AuxOutput

• Aux output

• Aux output configuration
• Type: object
• path: #/definitions/AuxOutput
• This schema does not accept additional properties.
• Properties
  • name required
    • Name
    • Type: string
    • path: #/definitions/AuxOutput/properties/name
    • Length: ≤ 8
  • gpio required
    • The gpio number
    • Type: integer
    • path: #/definitions/AuxOutput/properties/gpio

AuxAnalogInput

• Aux analog input

• Aux analog input configuration
• Type: object
• path: #/definitions/AuxAnalogInput
• This schema does not accept additional properties.
• Properties
  • name required
    • Name
    • Type: string
    • path: #/definitions/AuxAnalogInput/properties/name
    • Length: ≤ 8
  • adcChannel required
    • The adc1 channel
    • Type: integer
    • path: #/definitions/AuxAnalogInput/properties/adcChannel

Serial

• Serial

• Serial port configuration
• Type: object
• path: #/definitions/Serial
• This schema does not accept additional properties.
• Properties
  • type
    • Type
    • Type: string
    • path: #/definitions/Serial/properties/type
    • The value is restricted to the following:
      1. "uart"
      2. "rs485"
  • name
    • Name
    • Type: string
    • path: #/definitions/Serial/properties/name
    • Length: ≤ 16
  • rxdGpio
    • RX data gpio number
    • Type: integer
    • path: #/definitions/Serial/properties/rxdGpio
  • txdGpio
    • TX data gpio number
    • Type: integer
    • path: #/definitions/Serial/properties/txdGpio
  • rtsGpio
    • Flow control signal gpio number, required for rs485
    • Type: integer
    • path: #/definitions/Serial/properties/rtsGpio

Onewire

• Onewire

• Onewire bus configuration
• Type: object
• path: #/definitions/Onewire
• This schema does not accept additional properties.
• Properties
  • gpio required
    • Onewire bus gpio number
    • Type: integer
    • path: #/definitions/Onewire/properties/gpio
  • temperatureSensor required
    • Has temperature sensor on onewire bus
    • Type: boolean
    • path: #/definitions/Onewire/properties/temperatureSensor

Generated with json-schema-md-doc