Shrinking an IP address to fit on the PCD8544 Nokia 5110 style LCD - MicroPython Example

LCD status displays can really simplify troubleshooting IoT devices.  I need to know the IP address of the device. and MDNS doesn't always work for me.  I could log into my router to find the IPs of my devices but it is simpler to add a cheap display and log the IP address on the display. 

I have a pile of cheap Nokia-style modules that are 84 pixels x 48 pixels. The Adafruit Python driver defaults to a 5x8 font which results in 6x10 dot character spacing. 5 lines at 10 pixels tall is more than 48 pixels but we don't need the last two padding rows because there is nothing below them. That turns out to be 14 characters on the 5110-style LCD.  IP addresses can be 15 characters if all 5 octets are 3 decimal digits. This means it is possible to lose the last character of an IP address as shown below.


The separator characters don't need to be full fixed-width characters. We know they can be smaller than the digits used for the IP address octets.  The function down below renders the "." characters as narrow graphics in between the octets.

The top two rows demonstrate the default text behavior.  The 2nd row from the bottom shows how the text lays out if we compress the width of periods ".".

Click to expand

Video

Test Program

This code can be found on GitHub. There is a small block of LCD initialization code


spi = busio.SPI(board.SCK, MOSI=board.MOSI)
dc = digitalio.DigitalInOut(board.D6) # data/command
cs = digitalio.DigitalInOut(board.D5) # Chip select
reset = digitalio.DigitalInOut(board.D9) # reset
display = adafruit_pcd8544.PCD8544(spi, dc, cs, reset)
display.contrast = 60
display.fill(0)


This test program exercises our function by displaying a full 12-digit IP address: 888.888.888.888.  Our test program is verifying the rendering and does not care if the address is an actual valid IP address.


# compress the width needed by putting a blank space instead of "."
display.text('IP Address', 0, char_height*0, 1)
# can be too wide for screen
#display.text(wifi.radio.ipv4_address, 0, 10, 1)
our_address = wifi.radio.ipv4_address
display_ip_compressed(display, our_address, char_height*1)
# demo lines
display.text("Comp vs Trunc",0,char_height*2,1)
display_ip_compressed(display, "888.888.888.888",char_height*3)
display.text("888.888.888.888",0,char_height*4,1)
display.show()

The driver calls our re-usable IP address to render.  See the line in bold.

A reusable function that renders IP addresses

This function renders an IP address with compressed spacing for the "." separator characters.  You can just copy and paste this into your MicroPython or CircuitPython program.


# 5x8 - font
# 6x10 - pad one on the side and two on the bottom
# 5 lines of txt is 50 pixels or 48 because we don't need to pad last row
char_width = 6
char_height = 10
#  TODO do font size math to make this work on other displays
def display_ip_compressed(display, our_address, y_position):
  """
  writes out an IP address replacing 6 pixels wide '.' character with 4p pixels wide 2x2 square
  Nokia display is 84x48 = 14 characters wide = 84 pixels
  An IP address can be 3*4+3 = 15 characters
  Each character is 6 (5+1) wide.  3 characters are 18 plus a dot is 24 wide
  Each character is 10 (8+2) tall
  """
  display.text("              ",0,y_position,1) # erase the line
  display.rect((char_width*3)+(4*0)+1, y_position+(char_height-5), 2,2,1)
  display.rect((char_width*6)+(4*1)+1, y_position+(char_height-5), 2,2,1)
  display.rect((char_width*9)+(4*2)+1, y_position+(char_height-5), 2,2,1)

  if (our_address):
    our_octets = str(our_address).split(".")
    display.text(our_octets[0], (char_width*0)+(4*0), y_position, 1)
    display.text(our_octets[1], (char_width*3)+(4*1), y_position, 1)
    display.text(our_octets[2], (char_width*6)+(4*2), y_position, 1)
    display.text(our_octets[3], (char_width*9)+(4*3), y_position, 1)
 
  display.show()

The Seeed XIAO ESP32 C3

The display is significantly larger than the device it is attached to. The XIAO has 11 pins. The LCD uses5 fo those. I usually add an LED for status but do I really need it with a display?


Video

Revision

2023 01



Comments

Post a Comment

Popular posts from this blog

Installing the RNDIS driver on Windows 11 to use USB Raspberry Pi as network attached

Image
I do a lot of my development and configuration via ssh into my Raspberry Pi Zero over the RNDIS connection. Some models of the Raspberry PIs can be configured with  gadget drivers  that let the Raspberry pi emulate different devices when plugged into computers via USB. My favorite gadget  is the network profile that makes a Raspberry Pi look like an RNDIS-attached network device.  All types of network services travel over an RNDIS device without knowing it is a USB hardware connection. A Raspberry Pi shows up as a Remote NDIS (RNDIS) device when you plug the Pi into a PC or Mac via a USB cable. The gadget  in the Windows Device Manager picture shows this RNDIS Gadget connectivity between a Windows machine and a Raspberry Pi. The Problem Windows 11 and Windows 10 no longer auto-installs the RNDIS driver that makes magic happen. Windows recognizes that the Raspberry Pi is some type of generic USB COM device. Manually running W indows Update  or  Upd...
Read more

Understanding your WSL2 RAM and swap - Changing the default 50%-25%

Image
The Windows Subsystem for Linux operates as a virtual machine that can dynamically grow the amount of RAM to a maximum set at startup time.  Microsoft sets a default maximum RAM available to 50% of the physical memory and a swap-space that is 1/4 of the maximum WSL RAM.  You can scale those numbers up or down to allocate more or less RAM to the Linux instance. The first drawing shows the default WSL memory and swap space sizing. The images below show a developer machine that is running a dev environment in WSL2 and Docker Desktop.  Docker Desktop has two of its own WSL modules that need to be accounted for.  You can see that the memory would actually be oversubscribed, 3 x 50% if every VM used its maximum memory.  The actual amount of memory used is significantly smaller allowing every piece to fit. Click to Enlarge The second drawing shows the memory allocation on my 64GB laptop. WSL Linux defaul...
Read more

Almost PaaS Document Parsing with Tika and AWS Elastic Beanstalk

Image
The Apache Tika project provides a  library capable of parsing and extracting data and meta data from over 1000 file types.  Tika is available as a single jar file that can be included inside applications or as a deployable jar file that runs Tika as a standalone service. This blog describes deploying the Tika jar as an auto-scale service in Amazon AWS Elastic Beanstalk.  I selected Elastic Beanstalk because it supports jar based deployments without any real Infrastructure configuration. Elastic Beanstalk auto-scale should take care of scaling up and down for for the number of requests you get. Tika parses documents and extracts their text completely in memory. Tika was deployed for this blog using EC2 t2.micro instances available in the AWS free tier. t2.micro VMs are 1GB which means that you are restricted in document complexity and size. You would size your instances appropriately for your largest documents.   Preconditions An AWS account. AWS ac...
Read more