Formatting JSON for readability
Charly's Column – JSON
Armed with just json.tool and jq, Charly preps the JSON data delivered by his Philips Hue bridge so that even humans can read it – an essential step towards improving the usability of his home automation system.
Some time ago [1], I briefly talked about how I use the measured values from a lux sensor to control a Hue lighting system. In redecorating my hallway, I added some new lights and removed others. I couldn't remember the light sources' IDs, so I asked the Hue bridge to dump the configuration. What I got was hard-core JSON, but unfortunately not in a human-readable format (Figure 1).
Figure 1: Unreadable: Pure JSON.
There are plenty of tools to make JSON readable. I started with what I already had in place, json.tool, which the Python installation had dumped on my hard disk. I wrote its neatly formatted output to a file in /tmp for further processing (Listing 1).
Listing 1
JSON Query
$ curl --request GET 10.0.0.10/api/w25-4kqL7d|python -m json.tool > /tmp/hue.all
Listing 2
Light Source Script
01 #! /bin/bash 02 WDIR=/usr/local/shellscripts/lux 03 TMPDIR=/tmp 04 HUEBRIDGE=10.0.0.10 05 USER=w25-4kqL7d 06 07 for i in $(seq 1 20); do 08 echo "trying light $i"; 09 LAMPTEST=$(jq -r -M ".lights.\"$i\".name" /$TMPDIR/hue.all); 10 if [ "$LAMPTEST" != "null" ]; then 11 echo "Light $i exists: $LAMPTEST" 12 fi 13 done
However, I didn't need the data in Python; I wanted to use the output in a small Bash script. This prompted me to continue processing with jq [2]. The tool claims to be a kind of sed, awk, and grep for JSON. I wanted to find out the current IDs for my light sources, as well as discover their plain text names. Thanks to jq, a tiny script (Listing 2) is all it takes to do this. When I ran it, it gave me the output shown in Listing 3.
Listing 3
Script Output
Light 4 exists: LR_ceiling_desk Light 5 exists: LR_ceiling_sofa Light 6 exists: ColorWall1 Light 7 exists: Hall_1F Light 8 exists: Hall_2F Light 9 exists: Hall_3F Light 10 exists: LRTinkeringCorner
The reason why IDs 1 to 3 do not exist is because I dismantled the lights and removed them from the Hue app. The Hue bridge has no reason to re-sort the remaining IDs – which is fortunate, because that would cause total chaos every time I changed a lamp. As jq once again underlines: The shorter a tool's name is; the more important and powerful it is. Lights on!
Infos
- "Charly's Column – Hue and Rasp Pi" by Charly Kühnast, Linux Magazine, issue 218, January 2019, p.39, https://www.linux-magazine.com/Issues/2019/218/Hue-and-Rasp-Pi/(language)/eng-US
- jq: https://stedolan.github.io/jq/
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
US / Canada
UK / Australia
Direct Download
Read full article as PDF:
Price $2.95
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Find SysAdmin Jobs
News
-
Kubuntu Focus Announces XE Gen 2 Linux Laptop
Another Kubuntu-based laptop has arrived to be your next ultra-portable powerhouse with a Linux heart.
-
MNT Seeks Financial Backing for New Seven-Inch Linux Laptop
MNT Pocket Reform is a tiny laptop that is modular, upgradable, recyclable, reusable, and ships with Debian Linux.
-
Ubuntu Flatpak Remix Adds Flatpak Support Preinstalled
If you're looking for a version of Ubuntu that includes Flatpak support out of the box, there's one clear option.
-
Gnome 44 Release Candidate Now Available
The Gnome 44 release candidate has officially arrived and adds a few changes into the mix.
-
Flathub Vying to Become the Standard Linux App Store
If the Flathub team has any say in the matter, their product will become the default tool for installing Linux apps in 2023.
-
Debian 12 to Ship with KDE Plasma 5.27
The Debian development team has shifted to the latest version of KDE for their testing branch.
-
Planet Computers Launches ARM-based Linux Desktop PCs
The firm that originally released a line of mobile keyboards has taken a different direction and has developed a new line of out-of-the-box mini Linux desktop computers.
-
Ubuntu No Longer Shipping with Flatpak
In a move that probably won’t come as a shock to many, Ubuntu and all of its official spins will no longer ship with Flatpak installed.
-
openSUSE Leap 15.5 Beta Now Available
The final version of the Leap 15 series of openSUSE is available for beta testing and offers only new software versions.
-
Linux Kernel 6.2 Released with New Hardware Support
Find out what's new in the most recent release from Linus Torvalds and the Linux kernel team.