jc/docs/parsers/xrandr.md

Home

jc.parsers.xrandr

jc - JSON Convert xrandr command output parser

Usage (cli):

$ xrandr | jc --xrandr
$ xrandr --properties | jc --xrandr

or

$ jc xrandr

Usage (module):

import jc
result = jc.parse('xrandr', xrandr_command_output)

Schema:

{
  "screens": [
    {
      "screen_number":                     integer,
      "minimum_width":                     integer,
      "minimum_height":                    integer,
      "current_width":                     integer,
      "current_height":                    integer,
      "maximum_width":                     integer,
      "maximum_height":                    integer,
      "devices": [
        {
          "resolution_modes": [
            {
              "resolution_width":          integer,
              "resolution_height":         integer,
              "is_high_resolution":        boolean,
              "frequencies": [
                {
                  "frequency":             float,
                  "is_current":            boolean,
                  "is_preferred":          boolean
                }
              ]
            }
          ]
        }
      ],
      "is_connected":                      boolean,
      "is_primary":                        boolean,
      "device_name":                       string,
      "model_name":                        string,
      "product_id"                         string,
      "serial_number":                     string,
      "resolution_width":                  integer,
      "resolution_height":                 integer,
      "offset_width":                      integer,
      "offset_height":                     integer,
      "dimension_width":                   integer,
      "dimension_height":                  integer,
      "rotation":                          string,
      "reflection":                        string
    }
  ]
}

Examples:

$ xrandr | jc --xrandr -p
{
  "screens": [
    {
      "screen_number": 0,
      "minimum_width": 8,
      "minimum_height": 8,
      "current_width": 1920,
      "current_height": 1080,
      "maximum_width": 32767,
      "maximum_height": 32767,
      "devices": [
        {
          "resolution_modes": [
            {
              "resolution_width": 1920,
              "resolution_height": 1080,
              "is_high_resolution": false,
              "frequencies": [
                {
                  "frequency": 60.03,
                  "is_current": true,
                  "is_preferred": true
                },
                {
                  "frequency": 59.93,
                  "is_current": false,
                  "is_preferred": false
                }
              ]
            },
            {
              "resolution_width": 1680,
              "resolution_height": 1050,
              "is_high_resolution": false,
              "frequencies": [
                {
                  "frequency": 59.88,
                  "is_current": false,
                  "is_preferred": false
                }
              ]
            }
          ],
          "is_connected": true,
          "is_primary": true,
          "device_name": "eDP1",
          "resolution_width": 1920,
          "resolution_height": 1080,
          "offset_width": 0,
          "offset_height": 0,
          "dimension_width": 310,
          "dimension_height": 170,
          "rotation": "normal",
          "reflection": "normal"
        }
      ]
    }
  ]
}

$ xrandr --properties | jc --xrandr -p
{
  "screens": [
    {
      "screen_number": 0,
      "minimum_width": 8,
      "minimum_height": 8,
      "current_width": 1920,
      "current_height": 1080,
      "maximum_width": 32767,
      "maximum_height": 32767,
      "devices": [
        {
          "resolution_modes": [
            {
              "resolution_width": 1920,
              "resolution_height": 1080,
              "is_high_resolution": false,
              "frequencies": [
                {
                  "frequency": 60.03,
                  "is_current": true,
                  "is_preferred": true
                },
                {
                  "frequency": 59.93,
                  "is_current": false,
                  "is_preferred": false
                }
              ]
            },
            {
              "resolution_width": 1680,
              "resolution_height": 1050,
              "is_high_resolution": false,
              "frequencies": [
                {
                  "frequency": 59.88,
                  "is_current": false,
                  "is_preferred": false
                }
              ]
            }
          ],
          "is_connected": true,
          "is_primary": true,
          "device_name": "eDP1",
          "model_name": "ASUS VW193S",
          "product_id": "54297",
          "serial_number": "78L8021107",
          "resolution_width": 1920,
          "resolution_height": 1080,
          "offset_width": 0,
          "offset_height": 0,
          "dimension_width": 310,
          "dimension_height": 170,
          "rotation": "normal",
          "reflection": "normal"
        }
      ]
    }
  ]
}

parse

def parse(data: str, raw: bool = False, quiet: bool = False) -> Response

Main text parsing function

Parameters:

data:        (string)  text data to parse
raw:         (boolean) unprocessed output if True
quiet:       (boolean) suppress warning messages if True

Returns:

Dictionary. Raw or processed structured data.

Parser Information

Compatibility: linux, darwin, cygwin, aix, freebsd

Source: jc/parsers/xrandr.py

Version 2.0 by Kevin Lyter (code (at) lyterk.com)