USBHub_i2c_addresses.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": false,
    "inputHidden": false,
    "outputHidden": false
   },
   "outputs": [],
   "source": [
    "import yaml\n",
    "import pystache\n",
    "from IPython.display import display, HTML \n",
    "\n",
    "def numeric_addr(bitlist):\n",
    "    out = 0\n",
    "    for bit in bitlist:\n",
    "        out = (out << 1) | bit\n",
    "    return out\n",
    "\n",
    "def bitfield(n):\n",
    "    return [int(digit) for digit in bin(n)[2:]]\n",
    "\n",
    "def resolve(device, incr):\n",
    "    idx = 0\n",
    "    remap = {}\n",
    "    \n",
    "    if incr > device['adjustable_bits']**2:\n",
    "        raise Exception(\"Not enough address pins\") \n",
    "    \n",
    "    bitlist = device['address_struct']\n",
    "    \n",
    "    if incr > 0:\n",
    "        adjust = bitfield(incr)\n",
    "        adjust.reverse()\n",
    "        \n",
    "        ## Replace strings with values from a bit representation of the increment\n",
    "        for value in adjust:\n",
    "                \n",
    "            if \"A0\" in bitlist:\n",
    "                key = \"A{}\".format(idx)\n",
    "                if key not in bitlist:\n",
    "                    raise Exception(\"Expecting '{}' in address, not found\".format(key))\n",
    "                remap[key] = value\n",
    "                idx += 1\n",
    "                \n",
    "            else:\n",
    "                for digit in reversed(bitlist):\n",
    "                    if not str(digit).isdigit():\n",
    "                        if digit not in remap.keys():\n",
    "                            remap[digit] = value\n",
    "                        else:\n",
    "                            raise Exception(\"Not enough address pins\") \n",
    "                    \n",
    "        bitlist = [remap.get(n, n) for n in bitlist]\n",
    "\n",
    "    ## Replace any strings left over with zeros\n",
    "    return ([0 if isinstance(n, str) else n for n in bitlist], remap)\n",
    "\n",
    "class Devices:\n",
    "\n",
    "    def __init__(self, path='./i2c-addresses.yml'):\n",
    "\n",
    "        self.data = {}\n",
    "        with open(path) as f:\n",
    "            self.data = yaml.safe_load(f)\n",
    "\n",
    "        self.devices = []\n",
    "        self.taken = {}\n",
    "    \n",
    "    def add(self, name):\n",
    "        if name in self.data:\n",
    "            addr = self.data[name]\n",
    "            data = dict(\n",
    "                name=name, \n",
    "                address_struct=addr, \n",
    "                adjustable_bits = 7 - addr.count(0) - addr.count(1)\n",
    "            )\n",
    "            self.devices.append(data)\n",
    "        else:\n",
    "            raise Exception(\"Cannot find device: {}\".format(name))\n",
    "\n",
    "    def solve(self, html=False, debug=False, stdout=False):\n",
    "        ## Iterate through the selected devices by the number of adjustable bits\n",
    "        self.devices = sorted(self.devices, key=lambda d: d['adjustable_bits'])\n",
    "        \n",
    "        for idx, dev in enumerate(self.devices):\n",
    "            incr = 0\n",
    "\n",
    "            while True:\n",
    "                try:\n",
    "                    bits, remap = resolve(dev, incr)\n",
    "                    address = numeric_addr(bits)                \n",
    "                except Exception:\n",
    "                    if debug:\n",
    "                        print(\"WARN : Cannot resolve {} in slot {}, no free addresses\".format(dev['name'], idx))\n",
    "                    break\n",
    "\n",
    "                if address not in self.taken:\n",
    "                    dev['bits'] = bits\n",
    "                    dev['address'] = numeric_addr(bits)\n",
    "                    dev['remap'] = remap\n",
    "                    self.taken[address] = dev\n",
    "                    break\n",
    "\n",
    "                incr += 1\n",
    "                    \n",
    "        if stdout:\n",
    "            self.print()\n",
    "            \n",
    "        if html:\n",
    "            self.print_html()\n",
    "                \n",
    "\n",
    "    def print(self):\n",
    "        for addr, dev in self.taken.items():\n",
    "            print(\"{} @ {}\".format(dev['name'], hex(addr)))\n",
    "            print(\"\\t\", dev['address_struct'])\n",
    "            print(\"\\t\", dev['bits'])\n",
    "            print()\n",
    "            \n",
    "    def print_table(self):\n",
    "        out = []\n",
    "        out.append([\"IDX\", \"Name\", \"Address\", \"Configuration\"])\n",
    "        \n",
    "        for idx, dev in enumerate(self.devices):\n",
    "            if 'address' in dev:\n",
    "                addr = hex(dev['address'])\n",
    "            else:\n",
    "                addr = \"NONE\"\n",
    "            \n",
    "            out.append([idx, dev['name'], addr])\n",
    "            \n",
    "        return out\n",
    "    \n",
    "    def print_html(self, raw=False):\n",
    "        template = u\"\"\"<table>\n",
    "        <tr> <th>IDX</th> <th>Device</th> <th>Address</th> <th>Address Struct</th> <th>Mapping</th> </tr>\n",
    "        {{#device}}<tr>\n",
    "            <td>{{idx}}</td> <td>{{name}}</td> <td>{{{address_formatted}}}</td> <td>{{{address_string}}}</td> <td>{{mapping_string}}</td>\n",
    "        </tr>{{/device}}\n",
    "        </table>\"\"\"\n",
    "        \n",
    "        out = []\n",
    "        \n",
    "        for idx,dev in enumerate(self.devices):\n",
    "            \n",
    "            if 'address' in dev:\n",
    "                addr = hex(dev['address'])\n",
    "            else:\n",
    "                dev['bits'] = []\n",
    "                addr = \"<span style='color:red;'><b>NONE</b></span>\"\n",
    "              \n",
    "            dev['idx'] = idx\n",
    "            dev['address_formatted'] = addr\n",
    "            \n",
    "            mapping = zip(dev['address_struct'], dev['bits'])\n",
    "            mapping = [\"\" if a==b else \"{}:{}\".format(a,b) for (a,b) in list(mapping)]\n",
    "            dev['mapping_string'] = \"  \".join([str(b) for b in mapping])\n",
    "            \n",
    "            address = [str(b) for b in dev['address_struct']]\n",
    "            address = [b if b.isdigit() else \"<b>{}</b>\".format(b) for b in address]\n",
    "            dev['address_string'] = \" \".join(address)\n",
    "            \n",
    "            out.append(dev)\n",
    "      \n",
    "        html = pystache.render(template, dict(device=out))\n",
    "        \n",
    "        if raw:\n",
    "            return html\n",
    "        else:\n",
    "            display(HTML(html))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "collapsed": false,
    "inputHidden": false,
    "outputHidden": false
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<table>\n",
       "        <tr> <th>IDX</th> <th>Device</th> <th>Address</th> <th>Address Struct</th> <th>Mapping</th> </tr>\n",
       "        <tr>\n",
       "            <td>0</td> <td>UCS2113-1</td> <td>0x57</td> <td>1 0 1 0 1 1 1</td> <td>            </td>\n",
       "        </tr><tr>\n",
       "            <td>1</td> <td>UCS2113-2</td> <td>0x58</td> <td>1 0 1 1 0 0 0</td> <td>            </td>\n",
       "        </tr><tr>\n",
       "            <td>2</td> <td>ATECC508A</td> <td>0x60</td> <td>1 1 0 0 0 0 0</td> <td>            </td>\n",
       "        </tr><tr>\n",
       "            <td>3</td> <td>24AA025E48</td> <td>0x50</td> <td>1 0 1 0 0 <b>A1</b> <b>A0</b></td> <td>          A1:0  A0:0</td>\n",
       "        </tr><tr>\n",
       "            <td>4</td> <td>MCP23008</td> <td>0x20</td> <td>0 1 0 0 <b>A2</b> <b>A1</b> <b>A0</b></td> <td>        A2:0  A1:0  A0:0</td>\n",
       "        </tr><tr>\n",
       "            <td>5</td> <td>MCP9808</td> <td>0x18</td> <td>0 0 1 1 <b>A2</b> <b>A1</b> <b>A0</b></td> <td>        A2:0  A1:0  A0:0</td>\n",
       "        </tr><tr>\n",
       "            <td>6</td> <td>TLC59116</td> <td>0x61</td> <td>1 1 0 <b>A3</b> <b>A2</b> <b>A1</b> <b>A0</b></td> <td>      A3:0  A2:0  A1:0  A0:1</td>\n",
       "        </tr><tr>\n",
       "            <td>7</td> <td>TLC59116</td> <td>0x62</td> <td>1 1 0 <b>A3</b> <b>A2</b> <b>A1</b> <b>A0</b></td> <td>      A3:0  A2:0  A1:1  A0:0</td>\n",
       "        </tr>\n",
       "        </table>"
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "devices = Devices()\n",
    "\n",
    "devices.add('TLC59116')\n",
    "devices.add('TLC59116')\n",
    "devices.add('UCS2113-1')\n",
    "devices.add('UCS2113-2')\n",
    "devices.add('MCP23008')\n",
    "devices.add('24AA025E48')\n",
    "devices.add('ATECC508A')\n",
    "devices.add('MCP9808')\n",
    "\n",
    "devices.solve(html=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernel_info": {
   "name": "python3"
  },
  "kernelspec": {
   "display_name": "py_37_env",
   "language": "python",
   "name": "py_37_env"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.3"
  },
  "nteract": {
   "version": "0.12.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}