generator.py

# MIT license
#
# Skimibowi - SKiDL Microcontroller Board Wizard
# Copyright (C) 2019  Jussi Vestman
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""Generates microcontroller board descriptions in SKiDL"""

from generator_functions import requirements, generate_subcircuit, generate_connect_parts, import_statements
from passives_generator import generate_r, generate_device, generate_d
from esp_generator import generate_esp, generate_esp_01, generate_esp8266ex, generate_esp_uart_reset, generate_wemos_d1_mini
from arduino_generator import generate_atmega328p
from arduino_generator import generate_attiny85
from arduino_generator import generate_arduino_nano
from arduino_generator import generate_arduino_nano_v3_board_footprint
from arduino_generator import generate_arduino_uno_r3_board_footprint
from arduino_generator import generate_atmega_arduino_board_connections
from arduino_generator import generate_icsp
from arduino_generator import generate_arduino_reset_button
from arduino_generator import generate_arduino_ftdi_reset
from usb_uart_generator import generate_ftdi230, generate_ftdi232rl, generate_cp2104, generate_cp2102, generate_usb_connector, generate_vusb_avr
from battery_manager_generator import generate_mcp73831, mcp73871


def generate(args):
    """Generates microcontroller board descriptions in SKiDL """

    requirements.clear()
    import_statements.clear()

    code = ""

    if args.get('mcu') in ['ESP-12E', 'ESP-07']:
        code += generate_subcircuit(generate_esp, args)

    if args.get('mcu') in ['ESP-01']:
        code += generate_subcircuit(generate_esp_01, args)

    if args.get('mcu') in ['ESP8266EX']:
        code += generate_subcircuit(generate_esp8266ex, args)

    if args.get('mcu') == "WeMos D1 mini":
        code += generate_subcircuit(generate_wemos_d1_mini, args)

    if args.get('mcu') in ['ATmega328P-P', "ATmega328P-A", "ATmega328P-M"]:
        code += generate_atmega328p(args)
        if args['icsp']:
            code += generate_icsp()
        if args['Reset button']:
            code += generate_arduino_reset_button()
        if args['FTDI header']:
            code += generate_arduino_ftdi_reset(args)

    if args.get('mcu') in ['ATtiny85-20P', 'ATtiny85-20S', 'ATtiny85-20M']:
        code += generate_attiny85(args)

    if args.get('mcu') in ['Arduino Nano']:
        code += generate_arduino_nano(args)

    if args.get('powersource', 'No battery') not in ['No battery', 'JST PH S2B', 'Barrel Jack 2.0/5.5mm']:
        code += generate_battery(args)

    if args.get('powersource') in ['JST PH S2B', 'Barrel Jack 2.0/5.5mm']:
        code += generate_power_connector(args)

    if args.get('fuse', 'No fuse') != 'No fuse':
        code += generate_fuse(args)

    if args.get('switch', False):
        code += generate_power_switch(args)

    if args.get('battery_management', False) == 'MCP73871-2AA':
        code += generate_subcircuit(mcp73871, args)

    if args.get('battery_management', False) == 'MCP73831':
        code += generate_subcircuit(generate_mcp73831, args)

    if args.get('regulator_data', None):
        code += generate_regulator(args)

    if args.get('autoselect', False):
        code += generate_autoselect(args)

    if args.get('DS18B20', False) or args.get('DS18B20U', False) or args.get('onewire_connector', 'No Onewire connector') != 'No Onewire connector':
        code += generate_onewire_bus(args)

    if args.get('DS18B20', False):
        code += generate_18b20(args)

    if args.get('DS18B20U', False):
        code += generate_18b20u(args)

    if args.get('onewire_connector', "No Onewire connector") != "No Onewire connector":
        code += generate_onewire_connector(args)

    if args.get('ina219', False):
        code += generate_subcircuit(generate_ina219, args)

    if args.get('FTDI header', False):
        code += generate_ftdi_header(args)

    if args.get('usb_connector', 'No USB connector') != 'No USB connector':
        code += generate_usb_connector(args)

    if args.get('powersource', 'No battery') != 'No battery' \
       or args.get('usb_connector', 'No USB connector') != 'No USB connector':
        code += connect_power_network(args)

    if args.get('usb_uart', False) == 'FT231':
        code += generate_ftdi230(args)
        if args['mcu'] in ['ESP-12E', 'ESP-07']:
            code += generate_esp_uart_reset(args)

    if args.get('usb_uart', False) == 'FT232RL':
        code += generate_ftdi232rl(args)
        if args['mcu'] in ['ESP-12E', 'ESP-07']:
            code += generate_esp_uart_reset(args)

    if args.get('usb_uart', False) == 'CP2102N-A01-GQFN24':
        code += generate_cp2102(args)
        if args['mcu'] in ['ESP-12E', 'ESP-07']:
            code += generate_esp_uart_reset(args)

    if args.get('usb_uart', False) == 'CP2104':
        code += generate_subcircuit(generate_cp2104, args)
        if args['mcu'] in ['ESP-12E', 'ESP-07']:
            code += generate_subcircuit(generate_esp_uart_reset, args)

    if args.get('usb_uart', False) == 'VUSB-AVR':
        code += generate_vusb_avr(args)

    if args.get('hc12', False):
        code += generate_hc12(args)
        if args['mcu'] in ['ESP-12E', 'ESP-07']:
            code += generate_esp_software_serial(args)

    if args.get('sh1106', False):
        code += generate_sh1106(args)

    if args.get('si5351', False):
        code += generate_si5351(args)

    if args.get('board_footprint', False) == 'Arduino Uno R3':
        code += generate_arduino_uno_r3_board_footprint()
        if args['mcu'] in ['ATmega328P-P', 'ATmega328P-A', 'ATmega328P-M']:
            code += generate_atmega_arduino_board_connections()

    if args.get('board_footprint', False) == 'Arduino Nano':
        code += generate_arduino_nano_v3_board_footprint()
        if args['mcu'] in ['ATmega328P-P', 'ATmega328P-A', 'ATmega328P-M']:
            code += generate_atmega_arduino_board_connections()

    if args.get('board_footprint', False) == 'Adafruit Feather':
        code += generate_adafruit_feather(args)

    if args.get('mcu') in ['ESP8266EX', 'ESP-12E', 'ESP-07'] \
       and args.get('board_footprint') == 'Adafruit Feather':
        code += generate_adadafruit_feather_esp_connections(args)

    if args.get('title') and args.get('generate_labels'):
        code += generate_title(args)

    if args.get('author') and args.get('generate_labels'):
        code += generate_author(args)

    code += '''
generate_netlist()
'''

    import_statements.add('from skidl import generate_netlist')
    import_statements.add('from skidl import Net')
    import_statements.add('from skidl import Part')
    import_statements.add('from skidl import set_default_tool')
    import_statements.add('from skidl import KICAD7')

    import_code = "\n".join(import_statements)

    reqcode = "\n".join([requirement(args) for requirement in requirements])

    return f"""# Generated by Swimibowi - SKiDL Microcontroller Board Wizard
#
# MIT license
#
# Skimibowi - SKiDL Microcontroller Board Wizard
# Copyright (C) 2019  Jussi Vestman
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the \"Software\"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

\"\"\"Creates Kicad netlist file for a microcontroller board\"\"\"

{import_code}

set_default_tool(KICAD7)

""" + reqcode + code


def generate_battery(args):
    """Generate Battery Holder"""
    return '''
BATTERY = Part('Device', 'Battery', footprint='{powersource_footprint}')
BATTERY['+'] += Net.fetch('+VBatt')
BATTERY['-'] += Net.fetch('GND')
'''.format(**args)


def generate_power_switch(args):
    """Generate power switch"""
    return '''
SWITCH = Part('Switch', 'SW_DPDT_x2', footprint='Button_Switch_THT:SW_CuK_JS202011CQN_DPDT_Straight')
'''.format(**args)


def generate_fuse(args):
    """Generate Fuse"""
    return '''
FUSE = Part('Device', 'Fuse', footprint='{fuse_footprint}')
'''.format(**args)


def generate_power_connector(args):
    """Generate power connector"""
    if args.get('Battery management', False) == 'No battery management ic':
        args['battery_connector_pos'] = '+VLipo'
    else:
        args['battery_connector_pos'] = '+VBatt'

    return '''
BATTERY = Part('Connector', 'Conn_01x02_Socket', footprint='{powersource_footprint}')
BATTERY[1] += Net.fetch('{battery_connector_pos}')
BATTERY[2] += Net.fetch('GND')
'''.format(**args)


def connect_power_network(args):
    """Connect components that connect mcu/regulator throuh optional power switch, fuse and ina219 to battery"""
    if args.get('regulator_data', False):
        requirements.add(generate_device)
        requirements.add(generate_d)
        import_statements.add("from skidl import show")
        components = ['REGULATOR[\'VI\']', 'D("MBR0520LT", footprint=\'Diode_SMD:D_SOD-123\')[\'A,K\']']
    elif args.get('usb_connector', False) != 'No USB connector':
        components = ['Net.fetch(\'+VBus\')']
    else:
        components = ['Net.fetch(\'+VBatt\')']

    elements = {
        'ina219': 'INA219_R_SHUNT',
        'switch': 'SWITCH[1,2]',
        'fuse_footprint': 'FUSE'
    }

    for element in elements:
        if args.get(element, False):
            components.append(elements[element])

    if args['powersource'] != 'No battery':
        components.append('BATTERY')
    elif args.get('regulator', False) == 'No regulator':
        components.append('Net.fetch(\'{mcurail}\')'.format(**args))

    line = " & ".join(components)
    return '\n' + line + '\n'


def generate_autoselect(args):
    """Generate +5V/USB auto selector"""
    return '''
AUTOSELECTOR = Part('Device', 'D', footprint='Diode_SMD:D_SMA')
Net.fetch('+5V') & AUTOSELECTOR & Net.fetch('+VBus')
'''.format(*args)


def generate_onewire_bus(args):
    """Generate DQ net for onewire bus"""

    requirements.add(generate_r)

    mcurail = args['mcurail']

    if args['mcu'] == 'WeMos D1 mini':
        return f"""
U1['D4'] += Net.fetch('DQ')
Net.fetch('{mcurail}') & R('4k7') & Net.fetch('DQ')
"""

    return f"""
U1['GPIO2'] += Net.fetch('DQ')
Net.fetch('{mcurail}') & R('4k7') & Net.fetch('DQ')
"""


def generate_18b20u(args):
    """Generate 18B20U part and connect it to onewire bus"""
    return '''
U3 = Part('Sensor_Temperature', 'DS18B20U', footprint="Package_SO:MSOP-8_3x3mm_P0.65mm")
U3['VDD'] += Net.fetch('{mcurail}')
U3['GND'] += Net.fetch('GND')
U3['DQ'] += Net.fetch('DQ')
'''.format(**args)


def generate_18b20(args):
    """Generate 18b20 part and connect it to onewire bus"""
    return '''
U2 = Part('Sensor_Temperature', 'DS18B20', footprint="Package_TO_SOT_THT:TO-92_Inline")
U2['VDD'] += Net.fetch('{mcurail}')
U2['GND'] += Net.fetch('GND')
U2['DQ'] += Net.fetch('DQ')
'''.format(**args)


def generate_onewire_connector(args):
    """Generate connector for external onewire devices"""
    return '''
ONEWIRECONN = Part('Connector', 'Conn_01x03_Socket', footprint='{onewire_connector_footprint}')
ONEWIRECONN[1] += Net.fetch('{mcurail}')
ONEWIRECONN[2] += Net.fetch('DQ')
ONEWIRECONN[3] += Net.fetch('GND')
'''.format(**args)


def generate_ina219_i2c_address(args):
    """Generate resistors for setting up INA219 I2C bus address"""

    requirements.add(generate_r)

    return """
Net.fetch('GND') & R('10k') & INA219['A0']
Net.fetch('GND') & R('10k') & INA219['A1']
"""


def generate_ina219(args):
    """Generate INA219 that measures voltage and current at battery + terminal"""

    requirements.add(generate_r)

    return F"""
global INA219_R_SHUNT
INA219 = Part('Analog_ADC', 'INA219AxD', footprint='Package_SO:SOIC-8_3.9x4.9mm_P1.27mm')
INA219['VS'] += Net.fetch('{args['mcurail']}')
INA219['GND'] += Net.fetch('GND')

# Setup I2C bus
INA219['SDA'] += U1['GPIO4']
INA219['SCL'] += U1['GPIO5']
U1['GPIO4'] & R('10k') & Net.fetch('{args['mcurail']}')
U1['GPIO5'] & R('10k') & Net.fetch('{args['mcurail']}')

# Setup shunt resistor that is used to measure current from voltage drop
INA219_R_SHUNT = Part('Device', 'R', value='0.1', footprint='{args['resistor_footprint']}')
INA219['IN+'] += INA219_R_SHUNT[1]
INA219['IN-'] += INA219_R_SHUNT[2]

# Set I2C address
{generate_subcircuit(generate_ina219_i2c_address, args)}
"""


def generate_ftdi_header(args):
    """Generate header for connecting FTDI programmer"""

    return '''
FTDI_HEADER = Part('Connector', 'Conn_01x06_Pin', footprint='Skimibowi:FTDI_Header')
FTDI_HEADER[1] += Net.fetch('GND')
FTDI_HEADER[2] += Net.fetch('CTS')
FTDI_HEADER[3] += Net.fetch('{mcurail}')
FTDI_HEADER[4] += Net.fetch('rx')
FTDI_HEADER[5] += Net.fetch('tx')
FTDI_HEADER[6] += Net.fetch('RTS')
'''.format(**args)


def generate_regulator(args):
    """Generate regulator that regulates battery voltage to corresponding voltage rail"""

    module = args['regulator_data']['module']
    part = args['regulator_data']['part']
    footprint = args['regulator_data']['footprint']
    output = args['regulator_data']['output']
    enable_pin = args['regulator_data'].get('enable_pin')

    def regulator_enable():
        return ("""REGULATOR['EN'] & R('10k') & REGULATOR['VIN']
""" if enable_pin else '')

    def regulator_vin_bypass_cap(args):
        vin_bypass_cap = args.get('regulator_vin_bypass_cap')
        return (f"""Net.fetch('GND') & C('{vin_bypass_cap}') & REGULATOR['VI']
""" if vin_bypass_cap else '')

    def regulator_vout_bypass_cap(args):
        vout_bypass_cap = args.get('regulator_vout_bypass_cap')
        return (f"""Net.fetch('GND') & C('{vout_bypass_cap}') & REGULATOR['VO']
""" if vout_bypass_cap else '')

    return f"""
REGULATOR = Part('{module}', '{part}', value='{part}', footprint='{footprint}')
REGULATOR['VO'] += Net.fetch('{output}')
REGULATOR['GND'] += Net.fetch('GND')
""" + regulator_enable() + regulator_vin_bypass_cap(args) + regulator_vout_bypass_cap(args)


def generate_adafruit_feather(args):
    """Generate Adafruit Feather board footprint"""
    return '''
BOARD = Part('./library/feather.lib', 'Adafruit_Feather', footprint='Skimibowi:Adafruit_Feather')
'''.format(args)


def generate_adadafruit_feather_esp_connections(args):
    """Generate connections from ESP-module to Adafruit feather board"""

    import_statements.add("import itertools")
    requirements.add(generate_connect_parts)

    return f"""
connect_parts(BOARD, U1)

BOARD['RST'] += Net.fetch('RST')
BOARD['3V3'] += Net.fetch('+3V3')
BOARD['A0'] += Net.fetch('ADC')
BOARD['RX'] += Net.fetch('rx')
BOARD['TX'] += Net.fetch('tx')
BOARD['BAT'] += Net.fetch('+VBatt')
#BOARD['EN'] += NC # noqa: F821
BOARD['USB'] += Net.fetch('+VBus')
U1['ADC'] += Net.fetch('ADC')

BOARD['SCL'] += Net.fetch('SCL')
BOARD['SDA'] += Net.fetch('SDA')
U1['GPIO5'] += Net.fetch('SCL')
U1['GPIO4'] += Net.fetch('SDA')


"""


def generate_hc12(args):
    """Generate footprint for HC-12 RF-module"""

    return '''
HC12 = Part('./library/Skimibowi.lib', 'HC-12', footprint="Skimibowi:HC-12")
HC12['VCC'] += Net.fetch('{mcurail}')
HC12['GND'] += Net.fetch('GND')
HC12['RXD'] += Net.fetch('TXD2')
HC12['TXD'] += Net.fetch('RXD2')
'''.format(**args)


def generate_sh1106(args):
    """Generate footprint for SH1106 display module"""

    return '''
SH1106 = Part('./library/Skimibowi.lib', 'SH1106', footprint="Connector_PinHeader_2.54mm:PinHeader_1x07_P2.54mm_Vertical")
SH1106['GND'] += Net.fetch('GND')
SH1106['VCC'] += Net.fetch('+3V3')
SH1106['CLK'] += Net.fetch('SCLK')
SH1106['MOSI'] += Net.fetch('MOSI')
SH1106['RES'] += Net.fetch('RES')
SH1106['DC'] += Net.fetch('MISO')
SH1106['CS'] += Net.fetch('SS')
'''.format(**args)


def generate_si5351(args):
    """Generate footprint for SI5351"""

    return '''
SI5351 = Part('Oscillator', 'Si5351A-B-GT', footprint="Package_SO:MSOP-10_3x3mm_P0.5mm")
crystal = Part('Device','Crystal_GND24', value="ABM8G-25.000MHZ-4Y-T3", footprint='Crystal_SMD_Abracon_ABM8G-4Pin_3.2x2.5mm')
connector1 = Part('Connector', 'Conn_Coaxial', footprint='Connector_Coaxial:SMA_Amphenol_132289_EdgeMount')
connector2 = Part('Connector', 'Conn_Coaxial', footprint='Connector_Coaxial:SMA_Amphenol_132289_EdgeMount')
connector3 = Part('Connector', 'Conn_Coaxial', footprint='Connector_Coaxial:SMA_Amphenol_132289_EdgeMount')
SI5351['VDD'] += Net.fetch('+3V3')
SI5351['VDDO'] += Net.fetch('+3V3')
SI5351['GND'] += Net.fetch('GND')
SI5351['XA'] += crystal[1]
SI5351['XB'] += crystal[2]
SI5351['SDA'] += U1['GPIO4']
SI5351['SCL'] += U1['GPIO5']
SI5351['CLK0'] & connector1 & Net.fetch('GND')
SI5351['CLK1'] & connector2 & Net.fetch('GND')
SI5351['CLK2'] & connector3 & Net.fetch('GND')
'''


def generate_esp_software_serial(args):
    """Generate ESP software serial networks"""

    return '''
U1['GPIO13'] += Net.fetch('RXD2')
U1['GPIO15'] += Net.fetch('TXD2')
'''.format(**args)


def generate_title(args):
    """Generate visible title label for PCB to netlist"""

    title = args.get('title')

    return f"""
Part('./library/Skimibowi.lib', 'Label', ref=" ", value='{title}', footprint='Skimibowi:label{len(title)}')
"""


def generate_author(args):
    """Generate visible author label for PCB to netlist"""

    author = args.get('author')

    return f"""
Part('./library/Skimibowi.lib', 'Label', ref=" ", value='{author}', footprint='Skimibowi:label{len(author)}')
"""