2015-02-24 17:59:29 +08:00
|
|
|
#!/usr/bin/env python
|
|
|
|
import json
|
2015-02-25 06:07:11 +08:00
|
|
|
import markdown
|
2015-02-24 17:59:29 +08:00
|
|
|
import unicodedata
|
|
|
|
import re
|
2015-02-26 01:29:06 +08:00
|
|
|
import os
|
2015-03-22 05:11:54 +08:00
|
|
|
import time
|
2015-02-24 17:59:29 +08:00
|
|
|
|
2015-03-22 05:11:54 +08:00
|
|
|
base_url = '/pinout/'
|
|
|
|
resource_url = '/resources/'
|
2015-03-22 01:27:02 +08:00
|
|
|
|
2015-03-22 05:11:54 +08:00
|
|
|
|
|
|
|
overlays = [
|
2015-03-22 06:16:06 +08:00
|
|
|
'spi',
|
|
|
|
'uart',
|
|
|
|
'i2c',
|
|
|
|
'arduino-spi',
|
2015-03-22 05:11:54 +08:00
|
|
|
'pibrella',
|
|
|
|
'explorer-hat-pro',
|
|
|
|
'explorer-hat',
|
|
|
|
'display-o-tron'
|
|
|
|
]
|
2015-02-25 01:28:00 +08:00
|
|
|
|
|
|
|
template = open('template/layout.html').read()
|
2015-02-24 17:59:29 +08:00
|
|
|
|
2015-02-26 01:29:06 +08:00
|
|
|
pages = {}
|
2015-03-22 01:27:02 +08:00
|
|
|
navs = {}
|
2015-03-22 06:16:06 +08:00
|
|
|
select_overlays = []
|
2015-03-22 02:35:46 +08:00
|
|
|
|
|
|
|
overlays_html = ''
|
2015-02-26 01:29:06 +08:00
|
|
|
|
2015-03-22 05:11:54 +08:00
|
|
|
try:
|
|
|
|
os.mkdir('output/pinout')
|
|
|
|
except OSError:
|
|
|
|
pass
|
|
|
|
|
2015-02-24 17:59:29 +08:00
|
|
|
def slugify(value):
|
|
|
|
"""
|
|
|
|
Normalizes string, converts to lowercase, removes non-alpha characters,
|
|
|
|
and converts spaces to hyphens.
|
|
|
|
"""
|
|
|
|
value = unicode(value)
|
|
|
|
value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore').decode('ascii')
|
|
|
|
value = re.sub('[^\w\s-]', '', value).strip().lower()
|
|
|
|
return re.sub('[-\s]+', '_', value)
|
|
|
|
|
|
|
|
def load_overlay(overlay):
|
|
|
|
try:
|
2015-02-25 01:28:00 +08:00
|
|
|
loaded = json.load(open('overlay/{}.json'.format(overlay)))
|
2015-02-24 17:59:29 +08:00
|
|
|
except IOError:
|
|
|
|
return None
|
|
|
|
|
2015-02-25 06:07:11 +08:00
|
|
|
loaded['long_description'] = load_md('description/overlay/{}.md'.format(overlay))
|
2015-03-22 01:27:02 +08:00
|
|
|
|
|
|
|
details = []
|
|
|
|
|
|
|
|
if 'manufacturer' in loaded:
|
|
|
|
details.append('* Made by ' + loaded['manufacturer'])
|
|
|
|
|
|
|
|
if 'pincount' in loaded:
|
|
|
|
pincount = int(loaded['pincount'])
|
|
|
|
if pincount == 40:
|
|
|
|
details.append('* HAT form-factor')
|
|
|
|
elif pincount == 26:
|
|
|
|
details.append('* Classic 26-pin')
|
|
|
|
else:
|
|
|
|
details.append('* {} pin header'.format(pincount))
|
|
|
|
|
|
|
|
if 'pin' in loaded:
|
|
|
|
uses = len(loaded['pin'])
|
|
|
|
details.append('* Uses {} GPIO pins'.format(uses))
|
|
|
|
|
|
|
|
if 'url' in loaded:
|
|
|
|
details.append('* Resources: [{}]({})'.format(loaded['url'],loaded['url']))
|
|
|
|
|
|
|
|
loaded['long_description'] = '{}\n{}'.format(loaded['long_description'],markdown.markdown('\n'.join(details)))
|
|
|
|
|
|
|
|
loaded['page_url'] = slugify(loaded['name'])
|
|
|
|
pages[loaded['page_url']] = render_overlay_page(loaded)
|
|
|
|
navs[loaded['page_url']] = render_nav(loaded['page_url'], overlay=loaded)
|
2015-03-22 06:16:06 +08:00
|
|
|
select_overlays.append((loaded['page_url'], loaded['name']))
|
2015-03-22 01:27:02 +08:00
|
|
|
return loaded
|
2015-02-25 01:28:00 +08:00
|
|
|
|
2015-02-25 06:07:11 +08:00
|
|
|
def load_md(filename):
|
2015-02-25 01:28:00 +08:00
|
|
|
try:
|
2015-02-25 06:07:11 +08:00
|
|
|
html = markdown.markdown(open(filename).read(), extensions=['fenced_code'])
|
|
|
|
|
|
|
|
return html
|
|
|
|
#return markdown.markdown(open(filename).read(), extensions=[gfm.HiddenHiliteExtension([]),'fenced_code'])
|
2015-02-25 01:28:00 +08:00
|
|
|
except IOError:
|
2015-03-22 05:11:54 +08:00
|
|
|
return ''
|
2015-02-25 01:28:00 +08:00
|
|
|
|
2015-02-25 06:07:11 +08:00
|
|
|
def render_pin_text(pin_num, pin_url, pin_name, pin_subtext):
|
|
|
|
return '<article class="{}"><h1>{}</h1>{}{}</article>'.format(pin_url,pin_name,pin_subtext,load_md('description/pins/pin-{}.md'.format(pin_num)))
|
|
|
|
|
2015-02-25 01:28:00 +08:00
|
|
|
def render_overlay_page(overlay):
|
|
|
|
if overlay == None:
|
|
|
|
return ''
|
2015-02-25 06:07:11 +08:00
|
|
|
return '<article class="page_{}">{}</article>'.format(slugify(overlay['name']),overlay['long_description'])
|
2015-02-25 01:28:00 +08:00
|
|
|
|
2015-02-26 01:29:06 +08:00
|
|
|
#pages += map(render_overlay_page,overlays)
|
2015-02-25 06:07:11 +08:00
|
|
|
|
2015-02-24 17:59:29 +08:00
|
|
|
def render_alternate(handle, name):
|
|
|
|
handle = slugify(handle.lower())
|
|
|
|
return '<span class="alternate legend_{}">{}</span>'.format(handle,name)
|
|
|
|
|
2015-03-22 01:27:02 +08:00
|
|
|
def render_pin_page(pin_num):
|
2015-02-24 17:59:29 +08:00
|
|
|
pin = pins[str(pin_num)]
|
|
|
|
pin_url = pin['name']
|
2015-02-25 06:07:11 +08:00
|
|
|
pin_text_name = pin['name']
|
|
|
|
|
|
|
|
pin_subtext = []
|
2015-02-24 17:59:29 +08:00
|
|
|
|
2015-02-25 06:07:11 +08:00
|
|
|
|
|
|
|
pin_subtext.append('Physical pin {}'.format(pin_num))
|
|
|
|
|
2015-02-24 17:59:29 +08:00
|
|
|
if 'scheme' in pin:
|
|
|
|
if 'bcm' in pin['scheme']:
|
|
|
|
bcm = pin['scheme']['bcm']
|
|
|
|
pin_url = 'gpio{}'.format(bcm)
|
2015-03-22 01:27:02 +08:00
|
|
|
pin_subname_text = ''
|
|
|
|
pin_text_name = 'BCM {} {}'.format(bcm, pin_subname_text)
|
2015-02-24 17:59:29 +08:00
|
|
|
if pin['name'] != '':
|
2015-02-25 06:07:11 +08:00
|
|
|
pin_subname_text = '({})'.format(pin['name'])
|
|
|
|
pin_subtext.append('BCM pin {}'.format(bcm))
|
2015-02-24 17:59:29 +08:00
|
|
|
if 'wiringpi' in pin['scheme']:
|
|
|
|
wiringpi = pin['scheme']['wiringpi']
|
2015-02-25 06:07:11 +08:00
|
|
|
pin_subtext.append('Wiring Pi pin {}'.format(wiringpi))
|
|
|
|
if 'bcmAlt' in pin['scheme']:
|
|
|
|
bcmAlt = pin['scheme']['bcmAlt']
|
|
|
|
pin_subtext.append('BCM pin {} on Rev 1 ( very early ) Pi'.format(bcmAlt))
|
|
|
|
|
2015-02-24 17:59:29 +08:00
|
|
|
|
2015-02-25 06:07:11 +08:00
|
|
|
pin_url = slugify('pin{}_{}'.format(pin_num,pin_url))
|
|
|
|
|
|
|
|
pin_text = render_pin_text(pin_num,pin_url,pin_text_name,'<ul><li>{}</li></ul>'.format('</li><li>'.join(pin_subtext)))
|
2015-03-22 01:27:02 +08:00
|
|
|
#if pin_text != None:
|
|
|
|
return (pin_url, pin_text) #pages[pin_url] = pin_text
|
|
|
|
|
|
|
|
|
|
|
|
def render_pin(pin_num, selected_url, overlay=None):
|
|
|
|
pin = pins[str(pin_num)]
|
|
|
|
|
|
|
|
|
|
|
|
pin_type = list([x.strip() for x in pin['type'].lower().split('/')])
|
|
|
|
pin_url = pin['name']
|
|
|
|
pin_name = pin['name']
|
|
|
|
pin_text_name = pin['name']
|
|
|
|
pin_used = False
|
2015-03-22 06:16:06 +08:00
|
|
|
pin_link_title = []
|
2015-03-22 01:27:02 +08:00
|
|
|
|
|
|
|
|
|
|
|
if overlay != None and str(pin_num) in overlay['pin']:
|
2015-03-22 06:16:06 +08:00
|
|
|
overlay_pin = overlay['pin'][str(pin_num)]
|
2015-03-22 01:27:02 +08:00
|
|
|
pin_text_name = ''
|
2015-03-22 02:35:46 +08:00
|
|
|
#print(overlay)
|
2015-03-22 06:16:06 +08:00
|
|
|
pin_name = overlay_pin['name']
|
2015-03-22 01:27:02 +08:00
|
|
|
pin_used = True
|
2015-03-22 06:16:06 +08:00
|
|
|
|
|
|
|
if 'description' in overlay_pin:
|
|
|
|
pin_link_title.append(overlay_pin['description'])
|
2015-03-22 01:27:02 +08:00
|
|
|
#alternates = []
|
|
|
|
|
|
|
|
#for overlay in overlays:
|
|
|
|
# if overlay != None:
|
|
|
|
# if str(pin_num) in overlay['pin']:
|
|
|
|
# alternates.append(render_alternate(overlay['name'],overlay['pin'][str(pin_num)]['name']))
|
|
|
|
|
|
|
|
if 'scheme' in pin:
|
|
|
|
if 'bcm' in pin['scheme']:
|
|
|
|
bcm = pin['scheme']['bcm']
|
|
|
|
pin_subname = ''
|
|
|
|
#pin_subname_text = ''
|
|
|
|
#if pin_url == '':
|
|
|
|
pin_url = 'gpio{}'.format(bcm)
|
|
|
|
if pin_name != '': #pin['name'] != '':
|
|
|
|
pin_subname = '<small>({})</small>'.format(pin_name) #pin['name'])
|
|
|
|
# pin_subname_text = '({})'.format(pin['name'])
|
|
|
|
pin_name = 'BCM {} {}'.format(bcm, pin_subname)
|
|
|
|
# pin_text_name = 'BCM {} {}'.format(bcm, pin_subname_text)
|
2015-03-22 06:16:06 +08:00
|
|
|
if 'wiringpi' in pin['scheme']:
|
|
|
|
wiringpi = pin['scheme']['wiringpi']
|
|
|
|
pin_link_title.append('Wiring Pi pin {}'.format(wiringpi))
|
2015-03-22 01:27:02 +08:00
|
|
|
# alternates.append(render_alternate('wiringpi','Wiring Pi pin {}'.format(wiringpi)))
|
|
|
|
|
|
|
|
#print(pin_type)
|
|
|
|
|
2015-03-22 05:11:54 +08:00
|
|
|
pin_url = base_url + slugify('pin{}_{}'.format(pin_num,pin_url))
|
2015-03-22 01:27:02 +08:00
|
|
|
|
|
|
|
#print(selected_url)
|
|
|
|
selected = ''
|
2015-03-22 05:11:54 +08:00
|
|
|
|
|
|
|
if base_url + selected_url == pin_url:
|
2015-03-22 01:27:02 +08:00
|
|
|
selected = ' active'
|
|
|
|
if pin_used:
|
|
|
|
selected += ' overlay-pin'
|
2015-02-25 06:07:11 +08:00
|
|
|
|
2015-03-22 06:16:06 +08:00
|
|
|
return '<li class="pin{pin_num} {pin_type}{pin_selected}"><a href="{pin_url}" title="{pin_title}"><span class="default"><span class="phys">{pin_num}</span> {pin_name}</span><span class="pin"></span></a></li>\n'.format(
|
|
|
|
pin_num = pin_num,
|
|
|
|
pin_type = ' '.join(map(slugify,pin_type)),
|
|
|
|
pin_selected = selected,
|
|
|
|
pin_url = pin_url,
|
|
|
|
pin_title = ', '.join(pin_link_title),
|
|
|
|
pin_name = pin_name
|
2015-02-24 17:59:29 +08:00
|
|
|
)
|
|
|
|
|
2015-03-22 01:27:02 +08:00
|
|
|
def render_nav(url, overlay=None):
|
|
|
|
html_odd = ''
|
|
|
|
html_even = ''
|
2015-02-26 01:29:06 +08:00
|
|
|
for odd in range(1,len(pins),2):
|
2015-03-22 01:27:02 +08:00
|
|
|
html_odd += render_pin(odd, url,overlay)
|
|
|
|
html_even += render_pin(odd+1,url,overlay)
|
2015-02-25 01:28:00 +08:00
|
|
|
|
2015-02-26 01:29:06 +08:00
|
|
|
return '''<ul class="bottom">
|
2015-02-25 01:28:00 +08:00
|
|
|
{}</ul>
|
|
|
|
<ul class="top">
|
|
|
|
{}</ul>'''.format(html_odd, html_even)
|
|
|
|
|
2015-02-24 17:59:29 +08:00
|
|
|
|
2015-02-26 01:29:06 +08:00
|
|
|
|
2015-03-22 01:27:02 +08:00
|
|
|
|
|
|
|
db = json.load(open('pi-pinout.json'))
|
|
|
|
|
|
|
|
pins = db['pins']
|
|
|
|
|
|
|
|
overlays = map(load_overlay,overlays)
|
|
|
|
|
2015-03-22 06:16:06 +08:00
|
|
|
for url, name in select_overlays:
|
|
|
|
overlays_html += '<option value="{}">{}</option>'.format(url, name)
|
2015-03-22 02:35:46 +08:00
|
|
|
|
2015-03-22 01:27:02 +08:00
|
|
|
|
2015-03-22 05:11:54 +08:00
|
|
|
pages['pinout'] = render_overlay_page({'name':'Index','long_description':load_md('description/index.md')})
|
|
|
|
navs['pinout'] = render_nav('pinout')
|
2015-03-22 01:27:02 +08:00
|
|
|
|
|
|
|
print('Rendering pin pages...')
|
|
|
|
|
|
|
|
for pin in range(1,len(pins)+1):
|
|
|
|
(pin_url, pin_html) = render_pin_page(pin)
|
|
|
|
pin_nav = render_nav(pin_url)
|
2015-03-22 05:11:54 +08:00
|
|
|
pin_html = template.replace('{{nav}}',pin_nav).replace('{{content}}',pin_html).replace('{{resource_url}}',resource_url).replace('{{overlays}}',overlays_html).replace('{{v}}',str(int(time.time())))
|
2015-03-22 01:27:02 +08:00
|
|
|
|
|
|
|
print('Outputting page {}'.format(pin_url))
|
|
|
|
|
2015-03-22 05:11:54 +08:00
|
|
|
with open(os.path.join('output/pinout','{}.html'.format(pin_url)),'w') as f:
|
2015-03-22 01:27:02 +08:00
|
|
|
f.write(pin_html)
|
|
|
|
|
|
|
|
#nav = render_nav()
|
|
|
|
|
|
|
|
print('Rendering overlay and index pages...')
|
|
|
|
|
|
|
|
for url in pages:
|
|
|
|
content = pages[url]
|
|
|
|
nav = navs[url]
|
|
|
|
print('Outputting page {}'.format(url))
|
2015-03-22 05:11:54 +08:00
|
|
|
html = template.replace('{{nav}}',nav).replace('{{content}}',content).replace('{{resource_url}}',resource_url).replace('{{overlays}}',overlays_html).replace('{{v}}',str(int(time.time())))
|
|
|
|
|
|
|
|
if url != 'pinout':
|
|
|
|
url = os.path.join('pinout',url)
|
|
|
|
|
2015-03-22 01:27:02 +08:00
|
|
|
with open(os.path.join('output','{}.html'.format(url)),'w') as f:
|
2015-02-26 01:29:06 +08:00
|
|
|
f.write(html)
|
|
|
|
|