[ { "path": ".gitattributes", "content": "# Auto detect text files and perform LF normalization\n* text=auto\n\n# Custom for Visual Studio\n*.cs diff=csharp\n*.sln merge=union\n*.csproj merge=union\n*.vbproj merge=union\n*.fsproj merge=union\n*.dbproj merge=union\n\n# Standard to msysgit\n*.doc\t diff=astextplain\n*.DOC\t diff=astextplain\n*.docx diff=astextplain\n*.DOCX diff=astextplain\n*.dot diff=astextplain\n*.DOT diff=astextplain\n*.pdf diff=astextplain\n*.PDF\t diff=astextplain\n*.rtf\t diff=astextplain\n*.RTF\t diff=astextplain\n" }, { "path": ".gitignore", "content": "#################\n## Eclipse\n#################\n\n*.pydevproject\n.project\n.metadata\nbin/\ntmp/\n*.tmp\n*.bak\n*.swp\n*~.nib\nlocal.properties\n.classpath\n.settings/\n.loadpath\n\n# External tool builders\n.externalToolBuilders/\n\n# Locally stored \"Eclipse launch configurations\"\n*.launch\n\n# CDT-specific\n.cproject\n\n# PDT-specific\n.buildpath\n\n\n#################\n## Visual Studio\n#################\n\n## Ignore Visual Studio temporary files, build results, and\n## files generated by popular Visual Studio add-ons.\n\n# User-specific files\n*.suo\n*.user\n*.sln.docstates\n\n# Build results\n\n[Dd]ebug/\n[Rr]elease/\nx64/\nbuild/\n[Bb]in/\n[Oo]bj/\n\n# MSTest test Results\n[Tt]est[Rr]esult*/\n[Bb]uild[Ll]og.*\n\n*_i.c\n*_p.c\n*.ilk\n*.meta\n*.obj\n*.pch\n*.pdb\n*.pgc\n*.pgd\n*.rsp\n*.sbr\n*.tlb\n*.tli\n*.tlh\n*.tmp\n*.tmp_proj\n*.log\n*.vspscc\n*.vssscc\n.builds\n*.pidb\n*.log\n*.scc\n\n# Visual C++ cache files\nipch/\n*.aps\n*.ncb\n*.opensdf\n*.sdf\n*.cachefile\n\n# Visual Studio profiler\n*.psess\n*.vsp\n*.vspx\n\n# Guidance Automation Toolkit\n*.gpState\n\n# ReSharper is a .NET coding add-in\n_ReSharper*/\n*.[Rr]e[Ss]harper\n\n# TeamCity is a build add-in\n_TeamCity*\n\n# DotCover is a Code Coverage Tool\n*.dotCover\n\n# NCrunch\n*.ncrunch*\n.*crunch*.local.xml\n\n# Installshield output folder\n[Ee]xpress/\n\n# DocProject is a documentation generator add-in\nDocProject/buildhelp/\nDocProject/Help/*.HxT\nDocProject/Help/*.HxC\nDocProject/Help/*.hhc\nDocProject/Help/*.hhk\nDocProject/Help/*.hhp\nDocProject/Help/Html2\nDocProject/Help/html\n\n# Click-Once directory\npublish/\n\n# Publish Web Output\n*.Publish.xml\n*.pubxml\n\n# NuGet Packages Directory\n## TODO: If you have NuGet Package Restore enabled, uncomment the next line\n#packages/\n\n# Windows Azure Build Output\ncsx\n*.build.csdef\n\n# Windows Store app package directory\nAppPackages/\n\n# Others\nsql/\n*.Cache\nClientBin/\n[Ss]tyle[Cc]op.*\n~$*\n*~\n*.dbmdl\n*.[Pp]ublish.xml\n*.pfx\n*.publishsettings\n\n# RIA/Silverlight projects\nGenerated_Code/\n\n# Backup & report files from converting an old project file to a newer\n# Visual Studio version. Backup files are not needed, because we have git ;-)\n_UpgradeReport_Files/\nBackup*/\nUpgradeLog*.XML\nUpgradeLog*.htm\n\n# SQL Server files\nApp_Data/*.mdf\nApp_Data/*.ldf\n\n#############\n## Windows detritus\n#############\n\n# Windows image file caches\nThumbs.db\nehthumbs.db\n\n# Folder config file\nDesktop.ini\n\n# Recycle Bin used on file shares\n$RECYCLE.BIN/\n\n# Mac crap\n.DS_Store\n\n\n#############\n## Python\n#############\n\n*.py[co]\n\n# Packages\n*.egg\n*.egg-info\ndist/\nbuild/\neggs/\nparts/\nvar/\nsdist/\ndevelop-eggs/\n.installed.cfg\n\n# Installer logs\npip-log.txt\n\n# Unit test / coverage reports\n.coverage\n.tox\n\n#Translations\n*.mo\n\n#Mr Developer\n.mr.developer.cfg\n" }, { "path": "BeMicro/README.txt", "content": "BeMicro port by litecoin forum member \"Minor\" https://forum.litecoin.net/index.php?action=profile;u=15431\n\n+-------------------------------------------------------------------------------+\n; Flow Summary ;\n+------------------------------------+------------------------------------------+\n; Flow Status ; Successful - Wed Sep 18 13:46:51 2013 ;\n; Quartus II Version ; 10.1 Build 153 11/29/2010 SJ Web Edition ;\n; Revision Name ; ltcminer ;\n; Top-level Entity Name ; ltcminer ;\n; Family ; Cyclone IV E ;\n; Device ; EP4CE22F17C7 ;\n; Timing Models ; Final ;\n; Total logic elements ; 18,713 / 22,320 ( 84 % ) ;\n; Total combinational functions ; 16,012 / 22,320 ( 72 % ) ;\n; Dedicated logic registers ; 10,483 / 22,320 ( 47 % ) ;\n; Total registers ; 10483 ;\n; Total pins ; 9 / 154 ( 6 % ) ;\n; Total virtual pins ; 0 ;\n; Total memory bits ; 524,288 / 608,256 ( 86 % ) ;\n; Embedded Multiplier 9-bit elements ; 0 / 132 ( 0 % ) ;\n; Total PLLs ; 1 / 4 ( 25 % ) ;\n+------------------------------------+------------------------------------------+\n" }, { "path": "BeMicro/ltcminer.qpf", "content": "# -------------------------------------------------------------------------- #\n#\n# Copyright (C) 1991-2010 Altera Corporation\n# Your use of Altera Corporation's design tools, logic functions \n# and other software and tools, and its AMPP partner logic \n# functions, and any output files from any of the foregoing \n# (including device programming or simulation files), and any \n# associated documentation or information are expressly subject \n# to the terms and conditions of the Altera Program License \n# Subscription Agreement, Altera MegaCore Function License \n# Agreement, or other applicable license agreement, including, \n# without limitation, that your use is for the sole purpose of \n# programming logic devices manufactured by Altera and sold by \n# Altera or its authorized distributors. Please refer to the \n# applicable agreement for further details.\n#\n# -------------------------------------------------------------------------- #\n#\n# Quartus II\n# Version 10.0 Build 262 08/18/2010 Service Pack 1 SJ Web Edition\n# Date created = 19:43:05 May 18, 2011\n#\n# -------------------------------------------------------------------------- #\n\nQUARTUS_VERSION = \"10.0\"\nDATE = \"19:43:05 May 18, 2011\"\n\n# Revisions\n\nPROJECT_REVISION = \"ltcminer\"\n\n" }, { "path": "BeMicro/ltcminer.qsf", "content": "# -------------------------------------------------------------------------- #\n#\n# Copyright (C) 1991-2010 Altera Corporation\n# Your use of Altera Corporation's design tools, logic functions\n# and other software and tools, and its AMPP partner logic\n# functions, and any output files from any of the foregoing\n# (including device programming or simulation files), and any\n# associated documentation or information are expressly subject\n# to the terms and conditions of the Altera Program License\n# Subscription Agreement, Altera MegaCore Function License\n# Agreement, or other applicable license agreement, including,\n# without limitation, that your use is for the sole purpose of\n# programming logic devices manufactured by Altera and sold by\n# Altera or its authorized distributors. Please refer to the\n# applicable agreement for further details.\n#\n# -------------------------------------------------------------------------- #\n#\n# Quartus II\n# Version 10.0 Build 262 08/18/2010 Service Pack 1 SJ Web Edition\n# Date created = 05:05:52 March 02, 2011\n#\n# -------------------------------------------------------------------------- #\n#\n# Notes:\n#\n# 1) The default values for assignments are stored in the file:\n# If this file doesn't exist, see file:\n#\t\tassignment_defaults.qdf\n#\n# 2) Altera recommends that you do not modify this file. This\n# file is updated automatically by the Quartus II software\n# and any changes you make may be lost or overwritten.\n#\n# -------------------------------------------------------------------------- #\n\n\nset_global_assignment -name FAMILY \"Cyclone IV E\"\nset_global_assignment -name DEVICE EP4CE22F17C7\nset_global_assignment -name TOP_LEVEL_ENTITY ltcminer\nset_global_assignment -name LAST_QUARTUS_VERSION 10.1\nset_global_assignment -name MIN_CORE_JUNCTION_TEMP 0\nset_global_assignment -name MAX_CORE_JUNCTION_TEMP 85\nset_global_assignment -name ERROR_CHECK_FREQUENCY_DIVISOR 1\nset_global_assignment -name STRATIX_DEVICE_IO_STANDARD \"2.5 V\"\nset_global_assignment -name PROJECT_OUTPUT_DIRECTORY quartus_output\nset_global_assignment -name EDA_SIMULATION_TOOL \"\"\nset_global_assignment -name EDA_MAP_ILLEGAL_CHARACTERS OFF -section_id eda_simulation\nset_global_assignment -name EDA_TIME_SCALE \"1 ps\" -section_id eda_simulation\nset_global_assignment -name EDA_OUTPUT_DATA_FORMAT NONE -section_id eda_simulation\nset_global_assignment -name EDA_ENABLE_GLITCH_FILTERING OFF -section_id eda_simulation\nset_global_assignment -name EDA_WRITE_NODES_FOR_POWER_ESTIMATION OFF -section_id eda_simulation\nset_global_assignment -name EDA_TEST_BENCH_DESIGN_INSTANCE_NAME moogerfoogin -section_id eda_simulation\nset_global_assignment -name POWER_USE_PVA OFF\nset_global_assignment -name POWER_DEFAULT_TOGGLE_RATE 65%\nset_global_assignment -name VERILOG_SHOW_LMF_MAPPING_MESSAGES OFF\nset_global_assignment -name POWER_PRESET_COOLING_SOLUTION \"NO HEAT SINK WITH STILL AIR\"\nset_global_assignment -name POWER_BOARD_THERMAL_MODEL \"NONE (CONSERVATIVE)\"\nset_global_assignment -name SYNTH_TIMING_DRIVEN_SYNTHESIS ON\nset_global_assignment -name ALLOW_ANY_RAM_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ALLOW_ANY_ROM_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ALLOW_ANY_SHIFT_REGISTER_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ADD_PASS_THROUGH_LOGIC_TO_INFERRED_RAMS ON\nset_global_assignment -name REMOVE_REDUNDANT_LOGIC_CELLS ON\nset_global_assignment -name REMOVE_DUPLICATE_REGISTERS ON\nset_location_assignment PIN_E1 -to osc_clk\nset_instance_assignment -name IO_STANDARD \"3.3-V LVTTL\" -to osc_clk\nset_location_assignment PIN_N15 -to LEDS_out[0]\nset_location_assignment PIN_K5 -to LEDS_out[1]\nset_location_assignment PIN_P9 -to LEDS_out[2]\nset_location_assignment PIN_P15 -to LEDS_out[3]\nset_location_assignment PIN_R10 -to LEDS_out[4]\nset_location_assignment PIN_L13 -to LEDS_out[5]\nset_location_assignment PIN_D1 -to LEDS_out[6]\nset_location_assignment PIN_B1 -to LEDS_out[7]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[7]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[6]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[5]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[4]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[3]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[2]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[1]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[0]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[7]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[6]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[5]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[3]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[4]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[2]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[1]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[0]\nset_global_assignment -name VERILOG_MACRO \"HALFRAM=1\"\n#set_global_assignment -name QIP_FILE halfram.qip\n\nset_global_assignment -name PARTITION_NETLIST_TYPE SOURCE -section_id Top\nset_global_assignment -name PARTITION_FITTER_PRESERVATION_LEVEL PLACEMENT_AND_ROUTING -section_id Top\nset_global_assignment -name PARTITION_COLOR 16764057 -section_id Top\nset_global_assignment -name SMART_RECOMPILE ON\nset_global_assignment -name CYCLONEII_OPTIMIZATION_TECHNIQUE SPEED\nset_global_assignment -name PHYSICAL_SYNTHESIS_COMBO_LOGIC ON\nset_global_assignment -name PHYSICAL_SYNTHESIS_REGISTER_DUPLICATION ON\nset_global_assignment -name PHYSICAL_SYNTHESIS_REGISTER_RETIMING ON\nset_global_assignment -name ROUTER_LCELL_INSERTION_AND_LOGIC_DUPLICATION ON\nset_global_assignment -name ROUTER_TIMING_OPTIMIZATION_LEVEL MAXIMUM\nset_global_assignment -name AUTO_PACKED_REGISTERS_STRATIXII NORMAL\nset_global_assignment -name FITTER_EFFORT \"STANDARD FIT\"\nset_global_assignment -name ADV_NETLIST_OPT_SYNTH_WYSIWYG_REMAP ON\nset_global_assignment -name ROUTER_CLOCKING_TOPOLOGY_ANALYSIS ON\nset_global_assignment -name VERILOG_FILE ../source/ltcminer.v\nset_global_assignment -name VERILOG_FILE ../source/hashcore.v\nset_global_assignment -name VERILOG_FILE ../source/altera_ram.v\nset_global_assignment -name VERILOG_FILE ../source/salsa.v\nset_global_assignment -name VERILOG_FILE ../source/sha256_transform.v\nset_global_assignment -name VERILOG_FILE \"../source/sha-256-functions.v\"\nset_global_assignment -name VERILOG_FILE ../source/altera_pll.v\nset_global_assignment -name VERILOG_FILE ../source/altera_virtual_wire.v\nset_global_assignment -name SDC_FILE ltcminer.sdc\nset_global_assignment -name VERILOG_MACRO \"SPEED_MHZ=25\"\nset_global_assignment -name VERILOG_MACRO \"INVERTLEDS=1\"\nset_instance_assignment -name PARTITION_HIERARCHY root_partition -to | -section_id Top" }, { "path": "BeMicro/ltcminer.sdc", "content": "##\n#\n# Copyright (c) 2011 fpgaminer@bitcoin-mining.com\n#\n#\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with this program. If not, see .\n# \n##\n\ncreate_clock -period 20.000 -name osc_clk osc_clk\n\nderive_pll_clocks\nderive_clock_uncertainty\n\n" }, { "path": "DE0-Nano/ltcminer.qpf", "content": "# -------------------------------------------------------------------------- #\n#\n# Copyright (C) 1991-2010 Altera Corporation\n# Your use of Altera Corporation's design tools, logic functions \n# and other software and tools, and its AMPP partner logic \n# functions, and any output files from any of the foregoing \n# (including device programming or simulation files), and any \n# associated documentation or information are expressly subject \n# to the terms and conditions of the Altera Program License \n# Subscription Agreement, Altera MegaCore Function License \n# Agreement, or other applicable license agreement, including, \n# without limitation, that your use is for the sole purpose of \n# programming logic devices manufactured by Altera and sold by \n# Altera or its authorized distributors. Please refer to the \n# applicable agreement for further details.\n#\n# -------------------------------------------------------------------------- #\n#\n# Quartus II\n# Version 10.0 Build 262 08/18/2010 Service Pack 1 SJ Web Edition\n# Date created = 19:43:05 May 18, 2011\n#\n# -------------------------------------------------------------------------- #\n\nQUARTUS_VERSION = \"10.0\"\nDATE = \"19:43:05 May 18, 2011\"\n\n# Revisions\n\nPROJECT_REVISION = \"ltcminer\"\n\n" }, { "path": "DE0-Nano/ltcminer.qsf", "content": "# -------------------------------------------------------------------------- #\n#\n# Copyright (C) 1991-2010 Altera Corporation\n# Your use of Altera Corporation's design tools, logic functions\n# and other software and tools, and its AMPP partner logic\n# functions, and any output files from any of the foregoing\n# (including device programming or simulation files), and any\n# associated documentation or information are expressly subject\n# to the terms and conditions of the Altera Program License\n# Subscription Agreement, Altera MegaCore Function License\n# Agreement, or other applicable license agreement, including,\n# without limitation, that your use is for the sole purpose of\n# programming logic devices manufactured by Altera and sold by\n# Altera or its authorized distributors. Please refer to the\n# applicable agreement for further details.\n#\n# -------------------------------------------------------------------------- #\n#\n# Quartus II\n# Version 10.0 Build 262 08/18/2010 Service Pack 1 SJ Web Edition\n# Date created = 05:05:52 March 02, 2011\n#\n# -------------------------------------------------------------------------- #\n#\n# Notes:\n#\n# 1) The default values for assignments are stored in the file:\n# If this file doesn't exist, see file:\n#\t\tassignment_defaults.qdf\n#\n# 2) Altera recommends that you do not modify this file. This\n# file is updated automatically by the Quartus II software\n# and any changes you make may be lost or overwritten.\n#\n# -------------------------------------------------------------------------- #\n\n\nset_global_assignment -name FAMILY \"Cyclone IV E\"\nset_global_assignment -name DEVICE EP4CE22F17C6\nset_global_assignment -name TOP_LEVEL_ENTITY ltcminer\nset_global_assignment -name ORIGINAL_QUARTUS_VERSION \"10.0 SP1\"\nset_global_assignment -name PROJECT_CREATION_TIME_DATE \"17:52:09 MAY 05, 2011\"\nset_global_assignment -name LAST_QUARTUS_VERSION 10.1\nset_global_assignment -name MIN_CORE_JUNCTION_TEMP 0\nset_global_assignment -name MAX_CORE_JUNCTION_TEMP 85\nset_global_assignment -name ERROR_CHECK_FREQUENCY_DIVISOR 1\nset_global_assignment -name STRATIX_DEVICE_IO_STANDARD \"2.5 V\"\nset_global_assignment -name PARTITION_NETLIST_TYPE SOURCE -section_id Top\nset_global_assignment -name PARTITION_FITTER_PRESERVATION_LEVEL PLACEMENT_AND_ROUTING -section_id Top\nset_global_assignment -name PARTITION_COLOR 16764057 -section_id Top\nset_global_assignment -name LL_ROOT_REGION ON -section_id \"Root Region\"\nset_global_assignment -name LL_MEMBER_STATE LOCKED -section_id \"Root Region\"\nset_global_assignment -name PROJECT_OUTPUT_DIRECTORY quartus_output\nset_global_assignment -name EDA_SIMULATION_TOOL \"\"\nset_global_assignment -name EDA_MAP_ILLEGAL_CHARACTERS OFF -section_id eda_simulation\nset_global_assignment -name EDA_TIME_SCALE \"1 ps\" -section_id eda_simulation\nset_global_assignment -name EDA_OUTPUT_DATA_FORMAT NONE -section_id eda_simulation\nset_global_assignment -name EDA_ENABLE_GLITCH_FILTERING OFF -section_id eda_simulation\nset_global_assignment -name EDA_WRITE_NODES_FOR_POWER_ESTIMATION OFF -section_id eda_simulation\nset_global_assignment -name EDA_TEST_BENCH_DESIGN_INSTANCE_NAME moogerfoogin -section_id eda_simulation\nset_global_assignment -name POWER_USE_PVA OFF\nset_global_assignment -name POWER_DEFAULT_TOGGLE_RATE 65%\nset_global_assignment -name VERILOG_SHOW_LMF_MAPPING_MESSAGES OFF\nset_global_assignment -name POWER_PRESET_COOLING_SOLUTION \"NO HEAT SINK WITH STILL AIR\"\nset_global_assignment -name POWER_BOARD_THERMAL_MODEL \"NONE (CONSERVATIVE)\"\nset_global_assignment -name SYNTH_TIMING_DRIVEN_SYNTHESIS ON\nset_global_assignment -name ALLOW_ANY_RAM_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ALLOW_ANY_ROM_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ALLOW_ANY_SHIFT_REGISTER_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ADD_PASS_THROUGH_LOGIC_TO_INFERRED_RAMS ON\nset_global_assignment -name REMOVE_REDUNDANT_LOGIC_CELLS ON\nset_global_assignment -name REMOVE_DUPLICATE_REGISTERS ON\nset_location_assignment PIN_R8 -to osc_clk\nset_location_assignment PIN_A15 -to LEDS_out[0]\nset_location_assignment PIN_A11 -to LEDS_out[3]\nset_location_assignment PIN_A13 -to LEDS_out[1]\nset_location_assignment PIN_B13 -to LEDS_out[2]\nset_location_assignment PIN_D1 -to LEDS_out[4]\nset_location_assignment PIN_F3 -to LEDS_out[5]\nset_location_assignment PIN_B1 -to LEDS_out[6]\nset_location_assignment PIN_L3 -to LEDS_out[7]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[7]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[6]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[5]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[4]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[3]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[2]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[1]\nset_instance_assignment -name CURRENT_STRENGTH_NEW 8MA -to LEDS_out[0]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[7]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[6]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[5]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[3]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[4]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[2]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[0]\nset_instance_assignment -name SLEW_RATE 0 -to LEDS_out[1]\nset_global_assignment -name VERILOG_FILE \"../source/ltcminer.v\"\nset_global_assignment -name VERILOG_FILE \"../source/hashcore.v\"\nset_global_assignment -name VERILOG_FILE \"../source/altera_ram.v\"\nset_global_assignment -name VERILOG_FILE \"../source/salsa.v\"\nset_global_assignment -name VERILOG_FILE \"../source/sha256_transform.v\"\nset_global_assignment -name VERILOG_FILE \"../source/sha-256-functions.v\"\nset_global_assignment -name VERILOG_FILE \"../source/altera_pll.v\"\nset_global_assignment -name VERILOG_FILE \"../source/altera_virtual_wire.v\"\nset_global_assignment -name VERILOG_MACRO \"HALFRAM=1\"\n#set_global_assignment -name QIP_FILE halfram.qip\nset_instance_assignment -name PARTITION_HIERARCHY root_partition -to | -section_id Top" }, { "path": "DE0-Nano/ltcminer.sdc", "content": "##\n#\n# Copyright (c) 2011 fpgaminer@bitcoin-mining.com\n#\n#\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with this program. If not, see .\n# \n##\n\ncreate_clock -period 20.000 -name osc_clk osc_clk\n\nderive_pll_clocks\nderive_clock_uncertainty\n\n" }, { "path": "DE2-115-Single/README.txt", "content": "Single core version for DE2-115 using full sized scratchpad (UNTESTED)\n\nFor multipe cores simply replicate hashcore with different nonce_msb values and implement\na golden_nonce queue for results (a simple multiplexer latching on golden_nonce_match\nwill suffice). An dual core example is provided as a comment in ltcminer.v\nIts a little inefficient as the sha256 engine is replicated, but this will be rather\ncomplicated to fix.\n\nIt probably best to use half-sized scratchpads for the multicore version as\nthis doubles the number of cores that can be fitted for a 60% improvement in\nthroughput (the half cores being 80% as fast as a full scratchpad)\n set_global_assignment -name VERILOG_MACRO \"HALFRAM=1\"\n\nThis note from the previous version of the README is obsolete as multicore is now\nenabled by default ...\n For multicore, set the following in ltcminer.qsf ...\n set_global_assignment -name VERILOG_MACRO \"MULTICORE=1\"\n (Or use the assignments/settings menu in quartus to set it)\nUse the NOMULTICORE macro to revert to previous behaviour.\n\n" }, { "path": "DE2-115-Single/ltcminer.qpf", "content": "# -------------------------------------------------------------------------- #\n#\n# Copyright (C) 1991-2010 Altera Corporation\n# Your use of Altera Corporation's design tools, logic functions \n# and other software and tools, and its AMPP partner logic \n# functions, and any output files from any of the foregoing \n# (including device programming or simulation files), and any \n# associated documentation or information are expressly subject \n# to the terms and conditions of the Altera Program License \n# Subscription Agreement, Altera MegaCore Function License \n# Agreement, or other applicable license agreement, including, \n# without limitation, that your use is for the sole purpose of \n# programming logic devices manufactured by Altera and sold by \n# Altera or its authorized distributors. Please refer to the \n# applicable agreement for further details.\n#\n# -------------------------------------------------------------------------- #\n#\n# Quartus II\n# Version 10.1 Build 153 11/29/2010 SJ Web Edition\n# Date created = 19:35:13 July 19, 2013\n#\n# -------------------------------------------------------------------------- #\n\nQUARTUS_VERSION = \"10.1\"\nDATE = \"19:35:13 July 19, 2013\"\n\n# Revisions\n\nPROJECT_REVISION = \"ltcminer\"\nPROJECT_REVISION = \"ltcaminer\"\n" }, { "path": "DE2-115-Single/ltcminer.qsf", "content": "# -------------------------------------------------------------------------- #\n#\n# Copyright (C) 1991-2010 Altera Corporation\n# Your use of Altera Corporation's design tools, logic functions\n# and other software and tools, and its AMPP partner logic\n# functions, and any output files from any of the foregoing\n# (including device programming or simulation files), and any\n# associated documentation or information are expressly subject\n# to the terms and conditions of the Altera Program License\n# Subscription Agreement, Altera MegaCore Function License\n# Agreement, or other applicable license agreement, including,\n# without limitation, that your use is for the sole purpose of\n# programming logic devices manufactured by Altera and sold by\n# Altera or its authorized distributors. Please refer to the\n# applicable agreement for further details.\n#\n# -------------------------------------------------------------------------- #\n#\n# Quartus II\n# Version 10.0 Build 262 08/18/2010 Service Pack 1 SJ Web Edition\n# Date created = 05:05:52 March 02, 2011\n#\n# -------------------------------------------------------------------------- #\n#\n# Notes:\n#\n# 1) The default values for assignments are stored in the file:\n# If this file doesn't exist, see file:\n#\t\tassignment_defaults.qdf\n#\n# 2) Altera recommends that you do not modify this file. This\n# file is updated automatically by the Quartus II software\n# and any changes you make may be lost or overwritten.\n#\n# -------------------------------------------------------------------------- #\n\n\nset_global_assignment -name FAMILY \"Cyclone IV E\"\nset_global_assignment -name DEVICE EP4CE115F29C7\nset_global_assignment -name TOP_LEVEL_ENTITY ltcminer\nset_global_assignment -name ORIGINAL_QUARTUS_VERSION \"10.0 SP1\"\nset_global_assignment -name PROJECT_CREATION_TIME_DATE \"17:52:09 MAY 05, 2011\"\nset_global_assignment -name LAST_QUARTUS_VERSION 10.1\nset_global_assignment -name MIN_CORE_JUNCTION_TEMP 0\nset_global_assignment -name MAX_CORE_JUNCTION_TEMP 85\nset_global_assignment -name DEVICE_FILTER_SPEED_GRADE 7\nset_global_assignment -name ERROR_CHECK_FREQUENCY_DIVISOR 1\nset_global_assignment -name STRATIX_DEVICE_IO_STANDARD \"2.5 V\"\nset_location_assignment PIN_Y2 -to osc_clk\nset_instance_assignment -name IO_STANDARD \"3.3-V LVTTL\" -to osc_clk\nset_global_assignment -name ENABLE_SIGNALTAP OFF\nset_global_assignment -name POWER_PRESET_COOLING_SOLUTION \"23 MM HEAT SINK WITH 200 LFPM AIRFLOW\"\nset_global_assignment -name POWER_BOARD_THERMAL_MODEL \"NONE (CONSERVATIVE)\"\nset_global_assignment -name ALLOW_ANY_RAM_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name ALLOW_ANY_SHIFT_REGISTER_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name PARTITION_NETLIST_TYPE SOURCE -section_id Top\nset_global_assignment -name PARTITION_FITTER_PRESERVATION_LEVEL PLACEMENT_AND_ROUTING -section_id Top\nset_global_assignment -name PARTITION_COLOR 16764057 -section_id Top\nset_global_assignment -name LL_ROOT_REGION ON -section_id \"Root Region\"\nset_global_assignment -name LL_MEMBER_STATE LOCKED -section_id \"Root Region\"\nset_global_assignment -name PROJECT_OUTPUT_DIRECTORY quartus_output\nset_global_assignment -name REMOVE_REDUNDANT_LOGIC_CELLS ON\nset_global_assignment -name ALLOW_ANY_ROM_SIZE_FOR_RECOGNITION ON\nset_global_assignment -name EDA_SIMULATION_TOOL \"\"\nset_global_assignment -name EDA_MAP_ILLEGAL_CHARACTERS OFF -section_id eda_simulation\nset_global_assignment -name EDA_TIME_SCALE \"1 ps\" -section_id eda_simulation\nset_global_assignment -name EDA_OUTPUT_DATA_FORMAT NONE -section_id eda_simulation\nset_global_assignment -name EDA_ENABLE_GLITCH_FILTERING OFF -section_id eda_simulation\nset_global_assignment -name EDA_WRITE_NODES_FOR_POWER_ESTIMATION OFF -section_id eda_simulation\nset_global_assignment -name EDA_TEST_BENCH_DESIGN_INSTANCE_NAME moogerfoogin -section_id eda_simulation\nset_global_assignment -name POWER_USE_PVA OFF\nset_global_assignment -name POWER_DEFAULT_TOGGLE_RATE 65%\nset_global_assignment -name VERILOG_SHOW_LMF_MAPPING_MESSAGES OFF\nset_global_assignment -name VERILOG_FILE \"../source/ltcminer.v\"\nset_global_assignment -name VERILOG_FILE \"../source/hashcore.v\"\nset_global_assignment -name VERILOG_FILE \"../source/altera_ram.v\"\nset_global_assignment -name VERILOG_FILE \"../source/salsa.v\"\nset_global_assignment -name VERILOG_FILE \"../source/sha256_transform.v\"\nset_global_assignment -name VERILOG_FILE \"../source/sha-256-functions.v\"\nset_global_assignment -name VERILOG_FILE \"../source/altera_pll.v\"\nset_global_assignment -name VERILOG_FILE \"../source/altera_virtual_wire.v\"\nset_global_assignment -name VERILOG_MACRO \"NOLEDS=1\"\nset_instance_assignment -name PARTITION_HIERARCHY root_partition -to | -section_id Top" }, { "path": "DE2-115-Single/ltcminer.sdc", "content": "##\n#\n# Copyright (c) 2011 fpgaminer@bitcoin-mining.com\n#\n#\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with this program. If not, see .\n# \n##\n\ncreate_clock -period 20.000 -name osc_clk osc_clk\n\nderive_pll_clocks\nderive_clock_uncertainty\n\n" }, { "path": "ICARUS-LX150/MiningSoftware/README.txt", "content": "Mining software for ltcminer.\n\nYou will need to install python 2.7, then ...\n\nFrom the fpgaminer/project/Verilog_Xilinx_Port/README.txt I quote ...\n It requires a few non-standard libraries, pyserial and json-rpc.\n http://pyserial.sourceforge.net/\n (also generally available in Linux distributions)\n http://json-rpc.org/wiki/python-json-rpc\n\nSince these are open source, I have included them in the MiningSoftware folder, vis\n\npyserial-2.6 from http://pyserial.sourceforge.net\npython-json-rpc from http://json-rpc.org/browser/trunk/python-jsonrpc/jsonrpc\n\nTo install them run \"python setup.py install\" in each folder (sudo if on linux)\n\nEdit ltcminer.py and set the serial port to match your system (eg COM2) plus\nyour pool url, worker name and worker password. You can also change the baudrate\nbut this must match the value hard-coded into ltcminer_icarus.v\n\nThere is a test getwork that you can enable, just uncomment the two lines for\ntest_payload. This still requires a working pool, which will REJECT the share, but\nits a useful quick test that everything is working. This is now obsolete as I have\nprovided ltcminer-testmode.py which runs 10 test hashes (a full 910 test hash set is\nalso available in ../../scripts/test_data_cut.txt).\n\nThe scripts take a single (optional) parameter, the clock speed (in MHz) for use with\nthe dynamic clock PLL. The value is checked for validity in the FPGA, so not all values\nwill work (see SPEED_LIMIT and SPEED_MIN parameters in ltcminer_icarus.v). Use the\nFLASHCLOCK feature (blinks the TxD led in time to the clock) to verify the clock speed\nhas been accepted.\n\nBe careful of spaces/tabs in python as these are part of the syntax! If you run\ninto problems making changes, just copy a previous line EXACTLY, then modify the part\nafter the initial spaces/tabs. ADDENDUM. I have now tabbified the script with tabstop=4\n(using Notepad++) which should make it much easier to edit.\n\nWhen using a stratum proxy server, follow the instructions at ...\nhttps://www.litecoinpool.org/help\n\nSpecifically you must use the version from ...\nhttps://github.com/CryptoManiac/stratum-mining-proxy\n\nStart it as follows (on linux) ...\n./mining_proxy.py -nm -pa scrypt -o litecoinpool.org -p 3333\n\nOr in background with ...\nnohup ./mining_proxy.py -nm -pa scrypt -o litecoinpool.org -p 3333 >/tmp/stratum_ltc.log 2>&1&\n" }, { "path": "ICARUS-LX150/MiningSoftware/ltcminer-testmode.py", "content": "#!/usr/bin/env python\n\n# by teknohog\n\n# Python wrapper for Xilinx Serial Miner\n\n# Host/user configuration is NOT USED in ltcminer-testmode.py\n\n# CONFIGURATION - CHANGE THIS (eg try COM1, COM2, COM3, COM4 etc)\nserial_port = \"COM4\"\n# serial_port = \"/dev/ttyUSB0\"\t# raspberry pi\n\n# CONFIGURATION - how often to refresh work - reduced for testing\naskrate = 2\n\n###############################################################################\n\nfrom jsonrpc import ServiceProxy\nfrom time import ctime, sleep, time\nfrom serial import Serial\nfrom threading import Thread, Event\nfrom Queue import Queue\nimport sys\n\ndynclock = 0\ndynclock_hex = \"0000\"\n\ndef stats(count, starttime):\n\tkhshare = 65.536 * writer.diff\n\n\ts = sum(count)\n\ttdelta = time() - starttime\n\trate = s * khshare / tdelta\n\n\t# This is only a rough estimate of the true hash rate,\n\t# particularly when the number of events is low. However, since\n\t# the events follow a Poisson distribution, we can estimate the\n\t# standard deviation (sqrt(n) for n events). Thus we get some idea\n\t# on how rough an estimate this is.\n\n\t# s should always be positive when this function is called, but\n\t# checking for robustness anyway\n\tif s > 0:\n\t\tstddev = rate / s**0.5\n\telse:\n\t\tstddev = 0\n\n\treturn \"[%i accepted, %i failed, %.2f +/- %.2f khash/s]\" % (count[0], count[1], rate, stddev)\n\nclass Reader(Thread):\n\tdef __init__(self):\n\t\tThread.__init__(self)\n\n\t\tself.daemon = True\n\n\t\t# flush the input buffer\n\t\tser.read(1000)\n\n\tdef run(self):\n\t\twhile True:\n\t\t\tnonce = ser.read(4)\n\n\t\t\tif len(nonce) == 4:\n\t\t\t\t# Keep this order, because writer.block will be\n\t\t\t\t# updated due to the golden event.\n\t\t\t\tsubmitter = Submitter(writer.block, nonce)\n\t\t\t\tsubmitter.start()\n\t\t\t\tgolden.set()\n\n\nclass Writer(Thread):\n\tdef __init__(self,dynclock_hex):\n\t\tThread.__init__(self)\n\n\t\t# Keep something sensible available while waiting for the\n\t\t# first getwork\n\t\tself.block = \"0\" * 256\n\t\tself.target = \"f\" * 56 + \"ff070000\"\t\t# diff=32 for testmode\n\t\tself.diff = 32\t# testmode\n\t\tself.dynclock_hex = dynclock_hex\n\n\t\tself.daemon = True\n\t\tself.go = True\n\t\t# Alternatively use test_data_cut.txt for full 910 hash test suite\n\t\tself.infile = open(\"../../scripts/test_data.txt\",\"r\")\n\t\tself.nonce = 0\n\t\tself.nonce_tested = 0\n\t\tself.nonce_ok = 0\n\t\tself.nonce_fail = 0\n\n\tdef run(self):\n\t\twhile self.go:\n\t\t\ttry:\n\t\t\t\t# work = bitcoin.getwork()\n\t\t\t\t# self.block = work['data']\n\t\t\t\t# self.target = work['target']\n\t\t\t\tprint \"Tested\", self.nonce_tested, \" passed\", self.nonce_ok, \" fail\", self.nonce_fail, \" unmatched\", self.nonce_tested - self.nonce_ok - self.nonce_fail\n\t\t\t\tself.line = self.infile.readline()\n\t\t\t\tif (len(self.line) != 257):\n\t\t\t\t\tprint \"EOF on test data\"\t# Or its an error, but let's not be worrysome\n\n\t\t\t\t\t# quit()\t\t# Except it doesn't ...\n\t\t\t\t\tself.go = False\t# Terminating threads is a bit tricksy\n\t\t\t\t\tbreak\n\t\t\t\tself.nonce_tested = self.nonce_tested + 1\n\t\t\t\tself.block = self.line.rstrip()\n\t\t\t\t\n\t\t\t\t# Hard-code a diff=32 target for test work\n\t\t\t\t# Replace MSB 16 bits of target with clock (NB its reversed)\n\t\t\t\tself.target = \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffff07\" + self.dynclock_hex\n\t\t\t\tself.dynclock_hex = \"0000\"\t# Once only\n\t\t\t\t\n\t\t\t\t# print(\"block old \" + self.block)\n\t\t\t\t# We need to subtract a few from the nonces in order to match (why?)\n\t\t\t\tnonce_bin = self.block.decode('hex')[79:75:-1]\n\t\t\t\tself.nonce = int(nonce_bin.encode('hex'), 16)\n\t\t\t\t# print \"nonce old =\", self.nonce\n\t\t\t\tnonce_new = self.nonce - 50\n\t\t\t\tif (nonce_new < 0):\n\t\t\t\t\tnonce_new = 0\n\t\t\t\t# print \"nonce new =\", nonce_new\n\t\t\t\tnonce_hex = \"{0:08x}\".format(nonce_new)\n\t\t\t\t# print \"encoded = \", nonce_hex\n\t\t\t\tnonce_hex_rev = nonce_hex[6:8]+nonce_hex[4:6]+nonce_hex[2:4]+nonce_hex[0:2]\n\t\t\t\t# print \"reversed = \", nonce_hex_rev\n\t\t\t\tself.block = self.block[0:152]+nonce_hex_rev+self.block[160:]\n\t\t\t\t# print(\"block new \" + self.block)\n\t\t\texcept:\n\t\t\t\tprint(\"RPC getwork error\")\n\t\t\t\t# In this case, keep crunching with the old data. It will get \n\t\t\t\t# stale at some point, but it's better than doing nothing.\n\n\t\t\t# print(\"block \" + self.block + \" target \" + self.target)\t# DEBUG\n\n\t\t\tsdiff = self.target.decode('hex')[31:27:-1]\n\t\t\tintTarget = int(sdiff.encode('hex'), 16)\n\t\t\tif (intTarget < 1):\n\t\t\t\tprint \"WARNING zero target\", intTarget\n\t\t\t\tprint \"target\", self.target\n\t\t\t\tprint(\"sdiff\", sdiff)\t# NB Need brackets here else prints binary\n\t\t\t\tself.target = \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffff7f0000\"\n\t\t\telse:\n\t\t\t\tnewdiff = 65536.0 / (intTarget+1)\n\t\t\t\tif (self.diff != newdiff):\n\t\t\t\t\tprint \"New target diff =\", newdiff\n\t\t\t\tself.diff = newdiff\n\n\t\t\t# print(\"Sending data to FPGA\")\t# DEBUG\n\n\t\t\t# for litecoin send 80 bytes of the 128 byte data plus 4 bytes of 32 byte target\n\t\t\tpayload = self.target.decode('hex')[31:27:-1] + self.block.decode('hex')[79::-1]\n\t\t\t\n\t\t\t# TEST HASH, this should match on nonce 0000318f\n\t\t\t# NB The pool will REJECT this share as it did not send the data...\n\t\t\t# UNCOMMENT the following two lines for testing...\n\t\t\t# test_payload =\"000000014eb4577c82473a069ca0e95703254da62e94d1902ab6f0eae8b1e718565775af20c9ba6ced48fc9915ef01c54da2200090801b2d2afc406264d491c7dfc7b0b251e91f141b44717e00310000ff070000\"\n\t\t\t# payload = test_payload.decode('hex')[::-1]\n\n\t\t\t# This is probably best commented out unless debugging ...\n\t\t\tprint(\"Test \" + payload.encode('hex_codec'))\t# DEBUG\n\t\t\t\n\t\t\tser.write(payload)\n\t\t\t\n\t\t\tresult = golden.wait(askrate)\n\n\t\t\tif result:\n\t\t\t\tgolden.clear()\n\nclass Submitter(Thread):\n\tdef __init__(self, block, nonce):\n\t\tThread.__init__(self)\n\n\t\tself.block = block\n\t\tself.nonce = nonce\n\n\tdef run(self):\n\t\t# This thread will be created upon every submit, as they may\n\t\t# come in sooner than the submits finish.\n\n\t\t# print(\"Block found on \" + ctime())\n\t\tprint(\"Share found on \" + ctime() + \" nonce \" + self.nonce.encode('hex_codec'))\n\t\tif (int(self.nonce.encode('hex_codec'),16) != writer.nonce):\n\t\t\tprint \"... ERROR expected nonce\", hex(writer.nonce)\n\t\t\twriter.nonce_fail = writer.nonce_fail + 1\n\t\telse:\n\t\t\tprint \"... CORRECT\"\n\t\t\twriter.nonce_ok = writer.nonce_ok + 1\n\t\t\n\t\thrnonce = self.nonce[::-1].encode('hex')\n\n\t\tdata = self.block[:152] + hrnonce + self.block[160:]\n\n\t\ttry:\n\t\t\t# result = bitcoin.getwork(data)\n\t\t\tresult = False\n\t\t\t# print(\"Upstream result: \" + str(result))\t# Pointless in test mode\n\t\texcept:\n\t\t\tprint(\"RPC send error\")\n\t\t\t# a sensible boolean for stats\n\t\t\tresult = False\n\n\t\tresults_queue.put(result)\n\nclass Display_stats(Thread):\n\tdef __init__(self):\n\t\tThread.__init__(self)\n\n\t\tself.count = [0, 0]\n\t\tself.starttime = time()\n\t\tself.daemon = True\n\n\t\tprint(\"Miner started on \" + ctime())\n\n\tdef run(self):\n\t\twhile True:\n\t\t\tresult = results_queue.get()\n\t\t\t\n\t\t\tif result:\n\t\t\t\tself.count[0] += 1\n\t\t\telse:\n\t\t\t\tself.count[1] += 1\n\t\t\t\t\n\t\t\t# print(stats(self.count, self.starttime)) \t# Pointless in test mode\n\t\t\t\t\n\t\t\tresults_queue.task_done()\n\n# ======= main =======\n\n# Process command line\n\nif (len(sys.argv) > 2):\n\tprint \"ERROR too many command line arguments\"\n\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\tquit()\n\nif (len(sys.argv) == 1):\n\tprint \"WARNING no clockfreq supplied, not setting freq\"\nelse:\n\t# TODO ought to check the value is a valid integer\n\ttry:\n\t\tdynclock = int(sys.argv[1])\n\texcept:\n\t\tprint \"ERROR parsing clock frequency on command line, needs to be an integer\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tif (dynclock==0):\n\t\tprint \"ERROR parsing clock frequency on command line, cannot be zero\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tif (dynclock>254):\t# Its 254 since onescomplement(255) is zero, which is not allowed\n\t\tprint \"ERROR parsing clock frequency on command line, max 254\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tif (dynclock<25):\n\t\tprint \"ERROR use at least 25 for clock (the DCM can lock up for low values)\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tdynclock_hex = \"{0:04x}\".format((255-dynclock)*256+dynclock)\t# both value and ones-complement\n\tprint \"INFO will set clock to\", dynclock, \"MHz hex\", dynclock_hex\n\ngolden = Event()\n\n# url = 'http://' + user + ':' + password + '@' + host + ':' + http_port\n\n# bitcoin = ServiceProxy(url)\n\nresults_queue = Queue()\n\n# default is 8 bit no parity which is fine ...\n# http://pyserial.sourceforge.net/shortintro.html#opening-serial-ports\n\nser = Serial(serial_port, 115200, timeout=askrate)\n\nreader = Reader()\nwriter = Writer(dynclock_hex)\ndisp = Display_stats()\n\nreader.start()\nwriter.start()\ndisp.start()\n\ntry:\n\twhile writer.go:\n\t\t# Threads are generally hard to interrupt. So they are left\n\t\t# running as daemons, and we do something simple here that can\n\t\t# be easily terminated to bring down the entire script.\n\t\tsleep(1)\nexcept KeyboardInterrupt:\n\tprint(\"Terminated\")\n" }, { "path": "ICARUS-LX150/MiningSoftware/ltcminer.py", "content": "#!/usr/bin/env python\n\n# by teknohog\n\n# Python wrapper for Xilinx Serial Miner\n\n# CONFIGURATION - CHANGE THIS TO YOUR ACCOUNT DETAILS ...\n# Optionally install a Stratum Proxy Server\n\nhost = \"mining-foreman.org\"\t\t\t# Getwork pools\n# host = \"http://litecoinpool.org\"\n# host = \"localhost\"\t# Stratum Proxy on localhost\n# host = \"tvpi.lan\"\t\t# Stratum Proxy (raspberry pi)\n\nhttp_port = \"10341\"\t\t# Getwork port (mining-foreman)\n# http_port = \"9332\"\t# Getwork port (litcoinpool)\n# http_port = \"8332\"\t# Getwork port (stratum)\n\nuser = \"username.1\"\t\t# Your worker goes here\npassword = \"password\"\t# Worker password, NOT your account password\n\n# CONFIGURATION - CHANGE THIS (eg try COM1, COM2, COM3, COM4 etc)\nserial_port = \"COM4\"\n# serial_port = \"/dev/ttyUSB0\"\t# raspberry pi\n\n# CONFIGURATION - how often to refresh work. 20 seconds is fine, but work is\n# not initially fetched until this timeout expires. Reduce it for debugging\n# and for stratum (2 works fine).\naskrate = 20\t# Getwork\n# askrate = 2\t# Stratum\n\n###############################################################################\n\nfrom jsonrpc import ServiceProxy\nfrom time import ctime, sleep, time\nfrom serial import Serial\nfrom threading import Thread, Event\nfrom Queue import Queue\nimport sys\n\ndynclock = 0\ndynclock_hex = \"0000\"\n\ndef stats(count, starttime):\n\tkhshare = 65.536 * writer.diff\n\n\ts = sum(count)\n\ttdelta = time() - starttime\n\trate = s * khshare / tdelta\n\n\t# This is only a rough estimate of the true hash rate,\n\t# particularly when the number of events is low. However, since\n\t# the events follow a Poisson distribution, we can estimate the\n\t# standard deviation (sqrt(n) for n events). Thus we get some idea\n\t# on how rough an estimate this is.\n\n\t# s should always be positive when this function is called, but\n\t# checking for robustness anyway\n\tif s > 0:\n\t\tstddev = rate / s**0.5\n\telse:\n\t\tstddev = 0\n\n\treturn \"[%i accepted, %i failed, %.2f +/- %.2f khash/s]\" % (count[0], count[1], rate, stddev)\n\nclass Reader(Thread):\n\tdef __init__(self):\n\t\tThread.__init__(self)\n\n\t\tself.daemon = True\n\n\t\t# flush the input buffer\n\t\tser.read(1000)\n\n\tdef run(self):\n\t\twhile True:\n\t\t\tnonce = ser.read(4)\n\n\t\t\tif len(nonce) == 4:\n\t\t\t\t# Keep this order, because writer.block will be\n\t\t\t\t# updated due to the golden event.\n\t\t\t\tsubmitter = Submitter(writer.block, nonce)\n\t\t\t\tsubmitter.start()\n\t\t\t\tgolden.set()\n\n\nclass Writer(Thread):\n\tdef __init__(self,dynclock_hex):\n\t\tThread.__init__(self)\n\n\t\t# Keep something sensible available while waiting for the\n\t\t# first getwork\n\t\tself.block = \"0\" * 256\n\t\t# self.target = \"f\" * 56 + \"ff070000\"\t\t# diff=32\n\t\tself.target = \"f\" * 56 + \"ff7f0000\"\t\t\t# diff=2\n\t\tself.diff = 2.0\t# NB This is updated from target (default 2 is safer than 32 to avoid losing shares)\n\t\tself.dynclock_hex = dynclock_hex\n\n\t\tself.daemon = True\n\n\tdef run(self):\n\t\twhile True:\n\t\t\ttry:\n\t\t\t\twork = bitcoin.getwork()\n\t\t\t\tself.block = work['data']\n\t\t\t\tself.target = work['target']\n\t\t\texcept:\n\t\t\t\tprint(\"RPC getwork error\")\n\t\t\t\t# In this case, keep crunching with the old data. It will get \n\t\t\t\t# stale at some point, but it's better than doing nothing.\n\n\t\t\t# print(\"block \" + self.block + \" target \" + self.target)\t# DEBUG\n\n\t\t\tsdiff = self.target.decode('hex')[31:27:-1]\n\t\t\tintTarget = int(sdiff.encode('hex'), 16)\n\t\t\tif (intTarget < 1):\n\t\t\t\tprint \"WARNING zero target, defaulting to diff=2\", intTarget\n\t\t\t\tprint \"target\", self.target\n\t\t\t\tprint(\"sdiff\", sdiff)\t# NB Need brackets here else prints binary\n\t\t\t\tself.target = \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffff7f0000\"\n\t\t\telse:\n\t\t\t\tnewdiff = 65536.0 / (intTarget+1)\n\t\t\t\tif (self.diff != newdiff):\n\t\t\t\t\tprint \"New target diff =\", newdiff\n\t\t\t\tself.diff = newdiff\n\n\t\t\t# Replace MSB 16 bits of target with clock (NB its reversed)\n\t\t\tself.target = self.target[0:60] + self.dynclock_hex\n\t\t\tself.dynclock_hex = \"0000\"\t# Once only\n\t\t\t\n\t\t\tprint(\"Sending data to FPGA\")\t# DEBUG\n\n\t\t\t# for litecoin send 80 bytes of the 128 byte data plus 4 bytes of 32 byte target\n\t\t\tpayload = self.target.decode('hex')[31:27:-1] + self.block.decode('hex')[79::-1]\n\t\t\t\n\t\t\t# TEST HASH, this should match on nonce 0000318f\n\t\t\t# NB The pool will REJECT this share as it did not send the data...\n\t\t\t# UNCOMMENT the following two lines for testing...\n\t\t\t# test_payload =\"000000014eb4577c82473a069ca0e95703254da62e94d1902ab6f0eae8b1e718565775af20c9ba6ced48fc9915ef01c54da2200090801b2d2afc406264d491c7dfc7b0b251e91f141b44717e00310000ff070000\"\n\t\t\t# payload = test_payload.decode('hex')[::-1]\n\n\t\t\tprint(\"Payload \" + payload.encode('hex_codec'))\t# DEBUG\n\t\t\t\n\t\t\tser.write(payload)\n\t\t\t\n\t\t\tresult = golden.wait(askrate)\n\n\t\t\tif result:\n\t\t\t\tgolden.clear()\n\nclass Submitter(Thread):\n\tdef __init__(self, block, nonce):\n\t\tThread.__init__(self)\n\n\t\tself.block = block\n\t\tself.nonce = nonce\n\n\tdef run(self):\n\t\t# This thread will be created upon every submit, as they may\n\t\t# come in sooner than the submits finish.\n\n\t\t# print(\"Block found on \" + ctime())\n\t\tprint(\"Share found on \" + ctime() + \" nonce \" + self.nonce.encode('hex_codec'))\n\t\t\n\t\thrnonce = self.nonce[::-1].encode('hex')\n\n\t\tdata = self.block[:152] + hrnonce + self.block[160:]\n\n\t\ttry:\n\t\t\tresult = bitcoin.getwork(data)\n\t\t\tprint(\"Upstream result: \" + str(result))\n\t\texcept:\n\t\t\tprint(\"RPC send error\")\n\t\t\t# a sensible boolean for stats\n\t\t\tresult = False\n\n\t\tresults_queue.put(result)\n\nclass Display_stats(Thread):\n\tdef __init__(self):\n\t\tThread.__init__(self)\n\n\t\tself.count = [0, 0]\n\t\tself.starttime = time()\n\t\tself.daemon = True\n\n\t\tprint(\"Miner started on \" + ctime())\n\n\tdef run(self):\n\t\twhile True:\n\t\t\tresult = results_queue.get()\n\t\t\t\n\t\t\tif result:\n\t\t\t\tself.count[0] += 1\n\t\t\telse:\n\t\t\t\tself.count[1] += 1\n\t\t\t\t\n\t\t\tprint(stats(self.count, self.starttime))\n\t\t\t\t\n\t\t\tresults_queue.task_done()\n\n# ======= main =======\n\n# Process command line\n\nif (len(sys.argv) > 2):\n\tprint \"ERROR too many command line arguments\"\n\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\tquit()\n\nif (len(sys.argv) == 1):\n\tprint \"WARNING no clockfreq supplied, not setting freq\"\nelse:\n\t# TODO ought to check the value is a valid integer\n\ttry:\n\t\tdynclock = int(sys.argv[1])\n\texcept:\n\t\tprint \"ERROR parsing clock frequency on command line, needs to be an integer\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tif (dynclock==0):\n\t\tprint \"ERROR parsing clock frequency on command line, cannot be zero\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tif (dynclock>254):\t# Its 254 since onescomplement(255) is zero, which is not allowed\n\t\tprint \"ERROR parsing clock frequency on command line, max 254\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tif (dynclock<25):\n\t\tprint \"ERROR use at least 25 for clock (the DCM can lock up for low values)\"\n\t\tprint \"usage:\", sys.argv[0], \"clockfreq\"\n\t\tquit()\n\tdynclock_hex = \"{0:04x}\".format((255-dynclock)*256+dynclock)\t# both value and ones-complement\n\tprint \"INFO will set clock to\", dynclock, \"MHz hex\", dynclock_hex\n\ngolden = Event()\n\nurl = 'http://' + user + ':' + password + '@' + host + ':' + http_port\n\nbitcoin = ServiceProxy(url)\n\nresults_queue = Queue()\n\n# default is 8 bit no parity which is fine ...\n# http://pyserial.sourceforge.net/shortintro.html#opening-serial-ports\n\nser = Serial(serial_port, 115200, timeout=askrate)\n\nreader = Reader()\nwriter = Writer(dynclock_hex)\ndisp = Display_stats()\n\nreader.start()\nwriter.start()\ndisp.start()\n\ntry:\n\twhile True:\n\t\t# Threads are generally hard to interrupt. So they are left\n\t\t# running as daemons, and we do something simple here that can\n\t\t# be easily terminated to bring down the entire script.\n\t\tsleep(10000)\nexcept KeyboardInterrupt:\n\tprint(\"Terminated\")\n\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/CHANGES.txt", "content": "========================\n pySerial Release Notes\n========================\n\nVersion 1.0 13 Feb 2002\n---------------------------\n- First public release.\n- Split from the pybsl application (see http://mspgcc.sourceforge.net)\n\nNew Features:\n\n- Added Jython support\n\n\nVersion 1.1 14 Feb 2002\n---------------------------\nBugfixes:\n\n- Win32, when not specifying a timeout\n- Typos in the Docs\n\nNew Features:\n\n- added ``serialutil`` which provides a base class for the ``Serial``\n objects.\n\n- ``readline``, ``readlines``, ``writelines`` and ``flush`` are now supported\n see README.txt for deatils.\n\n\nVersion 1.11 14 Feb 2002\n---------------------------\nSame as 1.1 but added missing files.\n\n\nVersion 1.12 18 Feb 2002\n---------------------------\nRemoved unneded constants to fix RH7.x problems.\n\n\nVersion 1.13 09 Apr 2002\n---------------------------\nAdded alternate way for enabling rtscts (CNEW_RTSCTS is tried too)\nIf port opening fails, a ``SerialException`` is raised on all platforms\n\n\nVersion 1.14 29 May 2002\n---------------------------\nAdded examples to archive\nAdded non-blocking mode for ``timeout=0`` (tnx Mat Martineau)\n\nBugfixes:\n\n- win32 does now return the remaining characters on timeout\n\n\nVersion 1.15 04 Jun 2002\n---------------------------\nBugfixes (win32):\n\n- removed debug messages\n- compatibility to win9x improved\n\n\nVersion 1.16 02 Jul 2002\n---------------------------\nAdded implementation of RI and corrected RTS/CTS on Win32\n\n\nVersion 1.17 03 Jul 2002\n---------------------------\nSilly mix of two versions in win32 code corrected\n\n\nVersion 1.18 06 Dec 2002\n---------------------------\nBugfixes (general):\n\n- remove the mapping of flush to the destructive flushOutput as\n this is not the expected behaviour.\n- readline: EOL character for lines can be chosen idea by \n John Florian.\n\nBugfixes (posix):\n\n- cygwin port numbering fixed\n- test each and every constant for it's existence in termios module,\n use default if not existent (fix for Bug item #640214)\n- wrong exception on nonexistent ports with /dev file. bug report\n by Louis Cordier\n\nBugfixes (win32):\n\n- RTS/CTS handling as suggested in Bug #635072\n- bugfix of timeouts brought up by Markus Hoffrogge\n\n\nVersion 1.19 19 Mar 2003\n---------------------------\nBugfixes (posix):\n\n- removed ``dgux`` entry which actually had a wrong comment and is\n probably not in use anywhere.\n\nBugfixes (win32):\n\n- added ``int()`` conversion, [Bug 702120]\n- remove code to set control lines in close method of win32\n version. [Bug 669625]\n\n\nVersion 1.20 28 Aug 2003\n---------------------------\n- Added ``serial.device()`` for all platforms\n\nBugfixes (win32):\n\n- don't recreate overlapped structures and events on each\n read/write.\n- don't set unneeded event masks.\n- dont use DOS device names for ports > 9.\n- remove send timeout (its not used in the linux impl. anyway).\n\n\nVersion 1.21 30 Sep 2003\n---------------------------\nBugfixes (win32):\n\n- name for COM10 was not built correctly, found by Norm Davis.\n\nBugfixes (examples):\n\n- small change in ``miniterm.py`` that should mage it run on cygwin,\n [Bug 809904] submitted by Rolf Campbell.\n\n\nVersion 2.0b1 1 Oct 2003\n---------------------------\nTransition to the Python 2.0 series:\n\n- New implementation only supports Python 2.2+, backwards compatibility\n should be maintained almost everywhere.\n The OS handles (like the ``hComPort`` or ``fd`` attribute) were prefixed\n with an underscore. The different names stay, as anyone that uses one of\n these has to write platform specific code anyway.\n- Common base class ``serialutil.SerialBase`` for all implementations.\n- ``PARITY_NONE``, ``PARITY_EVEN``, ``PARITY_ODD`` constants changed and all\n these constants moved to ``serialutil.py`` (still available as\n ``serial.PARITY_NONE`` etc. and they should be used that way)\n- Added ``serial.PARITY_NAMES`` (implemented in ``serialutil.PARITY_NAMES``).\n This dictionary can be used to convert parity constants to meaningful\n strings.\n- Each Serial class and instance has a list of supported values:\n ``BAUDRATES``, ``BYTESIZES``, ``PARITIES``, ``STOPBITS``Ggg\n (i.e. ``serial.Serial.BAUDRATES or s = serial.Serial; s.BAUDRATES``)\n these values can be used to fill in value sin GUI dialogs etc.\n- Creating a ``Serial()`` object without port spec returns an unconfigured,\n closed port. Useful if a GUI dialog should take a port and configure\n it.\n- New methods for ``serial.Serial`` instances: ``open()``, ``isOpen()``\n- A port can be opened and closed as many times as desired.\n- Instances of ``serial.Serial`` have ``baudrate``, ``bytesize``, ``timeout``\n etc. attributes implemented as properties, all can be set while the port is\n opened. It will then be reconfigured.\n- Improved ``__doc__``'s.\n- New ``test_advanced.py`` for the property setting/getting testing.\n- Small bugfix on posix with get* methods (return value should be true a\n boolean).\n- added a ``__repr__`` that returns a meaningful string will all the serial\n setting, easy for debugging.\n- The serialposix module does not throw an exception on unsupported\n platforms, the message is still printed. The idea that it may still\n work even if the platform itself s not known, it simply tries to do\n the posix stuff anyway (It's likely that opening ports by number\n fails, but by name it should work).\n\n\nVersion 2.0b2 4 Oct 2003\n---------------------------\n- Added serial port configuration dialog for wxPython to the examples.\n- Added terminal application for wxPython with wxGlade design file\n to the examples.\n- Jython support is currently broken as Jython does not have a Python 2.2\n compatible release out yet\n\n\nVersion 2.0 6 Nov 2003\n---------------------------\n- Fixes ``setup.py`` for older distutils\n\n\nVersion 2.1 28 Jul 2004\n---------------------------\nBugfixes:\n\n- Fix XON/XOFF values [Bug 975250]\n\nBugfixes (posix):\n\n- ``fd == 0`` fix from Vsevolod Lobko\n- netbsd fixes from Erik Lindgren\n- Dynamicaly lookup baudrates and some cleanups\n\nBugfixes (examples):\n\n- CRLF handling of ``miniterm.py`` should be more consistent on Win32\n and others. Added LF only command line option\n- Multithreading fixes to ``wxTerminal.py`` (helps with wxGTK)\n- Small change for wxPython 2.5 in ``wxSerialConfigDialog.py`` [Bug 994856]\n\nNew Features:\n\n- Implement write timeouts (``writeTimeout`` parameter)\n\n\nVersion 2.2 31 Jul 2005\n---------------------------\nBugfixes:\n\n- [Bug 1014227]: property broken\n- [Bug 1105687]: ``serial_tcp_example.py``: ``--localport`` option\n- [Bug 1106313]: device (port) strings cannot be unicode\n\nBugfixes (posix):\n\n- [Patch 1043436] Fix for [Bug 1043420] (OSError: EAGAIN)\n- [Patch 1102700] ``fileno()`` added\n- ensure disabled PARMRK\n\nBugfixes (win32):\n\n- [Patch 983106]: keep RTS/CTS state on port setting changes\n\nNew Features:\n\n- ``dsrdtr`` setting to enable/disable DSR/DTR flow control independently\n from the ``rtscts`` setting. (Currenly Win32 only, ignored on other\n platforms)\n\n\nVersion 2.3 19 Jun 2008\n---------------------------\nNew Features:\n\n- iterator interface. ``for line in Serial(...): ...`` is now possible\n Suggested by Bernhard Bender\n- ``sendBreak()`` accepts a ``duration`` argument. Default duration increased.\n- win32 handles \\\\.\\COMx format automatically for com ports of higher number\n (COM10 is internally translated to \\\\.\\COM10 etc.)\n- miniterm.py has a new feature to send a file (upload) and configurable\n special characters for exit and upload. Refactored internals to class based\n structure (upload and class refactoring by Colin D Bennett)\n\nBugfixes:\n\n- [Bug 1451535] TCP/serial redirect example \"--help\"\n- update VERSION variable\n- update wxSerialConfigDialog.py and wxTerminal.py compatibility with\n wxPython 2.8 (Peleg)\n- Check for string in write function. Using unicode causes errors, this\n helps catching errors early (Tom Lynn)\n\nBugfixes (posix):\n\n- [Bug 1554183] setRTS/setDTR reference to non existing local \"on\"\n- [Bug 1513653] file descriptor not closed when exception is thrown\n- FreeBSD now uses cuadX instead of cuaaX (Patrick Phalen)\n\nBugfixes (win32):\n\n- [Bug 1520357] Handle leak\n- [Bug 1679013] Ignore exception raised by SetCommTimeout() in close().\n- [Bug 1938118] process hang forever under XP\n\n\nVersion 2.4 6 Jul 2008\n---------------------------\nNew Features:\n\n- [Patch 1616790] pyserial: Add inter-character timeout feature\n- [Patch 1924805] add a setBreak function\n- Add mark/space parity\n- Add .NET/Mono backend (IronPython)\n\nBugfixes (posix):\n\n- [Bug 1783159] Arbitrary baud rates (Linux/Posix)\n\nBugfixes (win32):\n\n- [Patch 1561423] Add mark/space parity, Win32\n- [Bug 2000771] serial port CANNOT be specified by number on windows\n- examples/scanwin32.py does no longer return \\\\.\\ names\n- fix \\\\.\\ handling for some cases\n\nBugfixes (jython):\n\n - The Jython backend tries javax.comm and gnu.io (Seo Sanghyeon)\n\n\nVersion 2.5-rc1 2009-07-30\n---------------------------\nNew Features:\n\n- Python 3.x support (through 2to3)\n- compatible with Python io library (Python 2.6+)\n- Support for Win32 is now written on the top of ctypes (bundled with\n Python 2.5+) instead of pywin32 (patch by Giovanni Bajo).\n- 1.5 stop bits (STOPBITS_ONE_POINT_FIVE, implemented on all platforms)\n- miniterm application extended (CTRL+T -> menu)\n- miniterm.py is now installed as \"script\"\n- add scanlinux.py example\n- add port_publisher example\n- experimental RFC-2217 server support (examples/rfc2217_server.py)\n- add ``getSettingsDict`` and ``applySettingsDict`` serial object methods\n- use a ``poll`` based implementation on Posix, instead of a ``select`` based,\n provides better error handling [removed again in later releases].\n\nBugfixes:\n\n- Improve and fix tcp_serial_redirector example.\n- [Bug 2603052] 5-bit mode (needs 1.5 stop bits in some cases)\n\nBugfixes (posix):\n\n- [Bug 2810169] Propagate exceptions raised in serialposix _reconfigure\n- [Bug 2562610] setting non standard baud rates on Darwin (Emmanuel Blot)\n\nBugfixes (win32):\n\n- [Bug 2469098] parity PARITY_MARK, PARITY_SPACE isn't supported on win32\n- [SF 2446218] outWaiting implemented\n- [Bug 2392892] scanwin32.py better exception handling\n- [Bug 2505422] scanwin32.py Vista 64bit compatibility\n\n\nVersion 2.5-rc2 2010-01-02\n---------------------------\nNew Features:\n\n- Documentation update, now written with Sphinx/ReST\n- Updated miniterm.py example\n- experimental RFC-2217 client support (serial.rfc2217.Serial, see docs)\n- add ``loop://`` device for testing.\n- add ``serial.serial_for_url`` factory function (support for native ports and\n ``rfc2217``, ``socket`` and ``loop`` URLs)\n- add new example: ``rfc2217_server.py``\n- tests live in their own directory now (no longer in examples)\n\nBugfixes:\n\n- [Bug 2915810] Fix for suboption parsing in rfc2217\n- Packaging bug (missed some files)\n\nBugfixes (posix):\n\n- improve write timeout behavior\n- [Bug 2836297] move Linux specific constants to not break other platforms\n- ``poll`` based implementation for ``read`` is in a separate class\n ``PosixPollSerial``, as it is not supported well on all platforms (the\n default ``Serial`` class uses select).\n- changed error handling in ``read`` so that disconnected devices are\n detected.\n\n\nBugfixes (win32):\n\n- [Bug 2886763] hComPort doesn't get initialized for Serial(port=None)\n\n\nVersion 2.5 2010-07-22\n---------------------------\nNew Features:\n\n- [Bug 2976262] dsrdtr should default to False\n ``dsrdtr`` parameter default value changed from ``None`` (follow ``rtscts``\n setting) to ``False``. This means ``rtscts=True`` enables hardware flow\n control on RTS/CTS but no longer also on DTR/DSR. This change mostly\n affects Win32 as on other platforms, that setting was ignored anyway.\n- Improved xreadlines, it is now a generator function that yields lines as they\n are received (previously it called readlines which would only return all\n lines read after a read-timeout). However xreadlines is deprecated an not\n available when the io module is used. Use ``for line in Serial(...):``\n instead.\n\nBugfixes:\n\n- [Bug 2925854] test.py produces exception with python 3.1\n- [Bug 3029812] 2.5rc2 readline(s) doesn't work\n\nBugfixes (posix):\n\n- [BUG 3006606] Nonblocking error - Unix platform\n\nBugfixes (win32):\n\n- [Bug 2998169] Memory corruption at faster transmission speeds.\n (bug introduced in 2.5-rc1)\n\n\nVersion 2.6 2011-11-02\n---------------------------\nNew Features:\n\n- Moved some of the examples to serial.tools so that they can be used\n with ``python -m``\n- serial port enumeration now included as ``serial.tools.list_ports``\n- URL handers for ``serial_for_url`` are now imported dynamically. This allows\n to add protocols w/o editing files. The list\n ``serial.protocol_handler_packages`` can be used to add or remove user\n packages with protocol handlers (see docs for details).\n- new URL type: hwgrep:// uses list_ports module to search for ports\n by their description\n- serveral internal changes to improve Python 3.x compatibility (setup.py,\n use of absolute imports and more)\n\nBugfixes:\n\n- [Bug 3093882] calling open() on an already open port now raises an exception\n- [Bug 3245627] connection-lost let rfc2217 hangs in closed loop\n- [Patch 3147043] readlines() to support multi-character eol\n\nBugfixes (posix):\n\n- [Patch 3316943] Avoid unneeded termios.tcsetattr calls in serialposix.py\n- [Patch 2912349] Serial Scan as a Module with Mac Support\n\nBugfixes (win32):\n\n- [Bug 3057499] writeTimeoutError when write Timeout is 0\n- [Bug 3414327] Character out of range in list_ports_windows\n- [Patch 3036175] Windows 98 Support fix\n- [Patch 3054352] RTS automatic toggle, for RS485 functionality.\n- Fix type definitions for 64 bit Windows compatibility\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/LICENSE.txt", "content": "Copyright (c) 2001-2011 Chris Liechti ;\nAll Rights Reserved.\n\nThis is the Python license. In short, you can use this product in\ncommercial and non-commercial applications, modify it, redistribute it.\nA notification to the author when you use and/or modify it is welcome.\n\n\nTERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING THIS SOFTWARE\n===================================================================\n\nLICENSE AGREEMENT\n-----------------\n\n1. This LICENSE AGREEMENT is between the copyright holder of this\nproduct, and the Individual or Organization (\"Licensee\") accessing\nand otherwise using this product in source or binary form and its\nassociated documentation.\n\n2. Subject to the terms and conditions of this License Agreement,\nthe copyright holder hereby grants Licensee a nonexclusive,\nroyalty-free, world-wide license to reproduce, analyze, test,\nperform and/or display publicly, prepare derivative works, distribute,\nand otherwise use this product alone or in any derivative version,\nprovided, however, that copyright holders License Agreement and\ncopyright holders notice of copyright are retained in this product\nalone or in any derivative version prepared by Licensee.\n\n3. In the event Licensee prepares a derivative work that is based on\nor incorporates this product or any part thereof, and wants to make\nthe derivative work available to others as provided herein, then\nLicensee hereby agrees to include in any such work a brief summary of\nthe changes made to this product.\n\n4. The copyright holder is making this product available to Licensee on\nan \"AS IS\" basis. THE COPYRIGHT HOLDER MAKES NO REPRESENTATIONS OR\nWARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION,\nTHE COPYRIGHT HOLDER MAKES NO AND DISCLAIMS ANY REPRESENTATION OR\nWARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR\nTHAT THE USE OF THIS PRODUCT WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.\n\n5. THE COPYRIGHT HOLDER SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER\nUSERS OF THIS PRODUCT FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL\nDAMAGES OR LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE\nUSING THIS PRODUCT, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE\nPOSSIBILITY THEREOF.\n\n6. This License Agreement will automatically terminate upon a material\nbreach of its terms and conditions.\n\n7. Nothing in this License Agreement shall be deemed to create any\nrelationship of agency, partnership, or joint venture between the\ncopyright holder and Licensee. This License Agreement does not grant\npermission to use trademarks or trade names from the copyright holder\nin a trademark sense to endorse or promote products or services of\nLicensee, or any third party.\n\n8. By copying, installing or otherwise using this product, Licensee\nagrees to be bound by the terms and conditions of this License\nAgreement.\n\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/MANIFEST.in", "content": "include README.txt\ninclude LICENSE.txt\ninclude CHANGES.txt\ninclude MANIFEST.in\ninclude setup.py\n\ninclude examples/enhancedserial.py\ninclude examples/miniterm.py\ninclude examples/port_publisher.py\ninclude examples/port_publisher.sh\ninclude examples/rfc2217_server.py\ninclude examples/scan.py\ninclude examples/scanlinux.py\ninclude examples/scanwin32.py\ninclude examples/setup-miniterm-py2exe.py\ninclude examples/setup-rfc2217_server-py2exe.py\ninclude examples/setup-wxTerminal-py2exe.py\ninclude examples/tcp_serial_redirect.py\ninclude examples/wxSerialConfigDialog.py\ninclude examples/wxSerialConfigDialog.wxg\ninclude examples/wxTerminal.py\ninclude examples/wxTerminal.wxg\n\ninclude test/run_all_tests.py\ninclude test/test.py\ninclude test/test_advanced.py\ninclude test/test_high_load.py\ninclude test/test_io_lib.py\ninclude test/test_readline.py\n\ninclude documentation/*.rst\ninclude documentation/pyserial.png\ninclude documentation/conf.py\ninclude documentation/Makefile\n\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/PKG-INFO", "content": "Metadata-Version: 1.0\nName: pyserial\nVersion: 2.6\nSummary: Python Serial Port Extension\nHome-page: http://pyserial.sourceforge.net/\nAuthor: Chris Liechti\nAuthor-email: cliechti@gmx.net\nLicense: Python\nDescription: Python Serial Port Extension for Win32, Linux, BSD, Jython, IronPython\nPlatform: any\nClassifier: Development Status :: 5 - Production/Stable\nClassifier: Intended Audience :: Developers\nClassifier: Intended Audience :: End Users/Desktop\nClassifier: License :: OSI Approved :: Python Software Foundation License\nClassifier: Natural Language :: English\nClassifier: Operating System :: POSIX\nClassifier: Operating System :: Microsoft :: Windows\nClassifier: Programming Language :: Python\nClassifier: Programming Language :: Python :: 2\nClassifier: Programming Language :: Python :: 2.3\nClassifier: Programming Language :: Python :: 2.4\nClassifier: Programming Language :: Python :: 2.5\nClassifier: Programming Language :: Python :: 2.6\nClassifier: Programming Language :: Python :: 2.7\nClassifier: Programming Language :: Python :: 3\nClassifier: Programming Language :: Python :: 3.0\nClassifier: Programming Language :: Python :: 3.1\nClassifier: Programming Language :: Python :: 3.2\nClassifier: Topic :: Communications\nClassifier: Topic :: Software Development :: Libraries\nClassifier: Topic :: Software Development :: Libraries :: Python Modules\nClassifier: Topic :: Terminals :: Serial\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/README.txt", "content": "==========\n pySerial\n==========\n\nOverview\n========\nThis module encapsulates the access for the serial port. It provides backends\nfor Python running on Windows, Linux, BSD (possibly any POSIX compliant\nsystem), Jython and IronPython (.NET and Mono). The module named \"serial\"\nautomatically selects the appropriate backend.\n\n- Project Homepage: http://pyserial.sourceforge.net\n- Project page on SourceForge: http://sourceforge.net/projects/pyserial/\n- SVN repository: http://sourceforge.net/svn/?group_id=46487\n- Download Page: http://sourceforge.net/project/showfiles.php?group_id=46487\n\nBSD license, (C) 2001-2011 Chris Liechti \n\n\nDocumentation\n=============\nFor API documentation, usage and examples see files in the \"documentation\"\ndirectory. The \".rst\" files can be read in any text editor or being converted to\nHTML or PDF using Sphinx. An online HTML version is at\nhttp://pyserial.sourceforge.net.\n\n\nExamples\n========\nExamples and unit tests are in the directory \"examples\".\n\n\nInstallation\n============\nDetailed information can be found in \"documentation/pyserial.rst\".\n\nThe usual setup.py for Python libraries is used for the source distribution.\nWindows installers are also available (see download link above).\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/Makefile", "content": "# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest\n\nhelp:\n\t@echo \"Please use \\`make ' where is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf _build/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in _build/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in _build/dirhtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in _build/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in _build/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator _build/qthelp/pySerial.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile _build/qthelp/pySerial.qhc\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in _build/latex.\"\n\t@echo \"Run \\`make all-pdf' or \\`make all-ps' in that directory to\" \\\n\t \"run these through (pdf)latex.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes\n\t@echo\n\t@echo \"The overview file is in _build/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in _build/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in _build/doctest/output.txt.\"\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/appendix.rst", "content": "==========\n Appendix\n==========\n\nHow To\n======\n\nEnable :rfc:`2217` in programs using pySerial.\n Patch the code where the :class:`serial.Serial` is instantiated. Replace\n it with::\n\n try:\n s = serial.serial_for_url(...)\n except AttributeError:\n s = serial.Serial(...)\n\n Assuming the application already stores port names as strings that's all\n that is required. The user just needs a way to change the port setting of\n your application to an ``rfc2217://`` :ref:`URL ` (e.g. by editing a\n configuration file, GUI dialog etc.).\n\n Please note that this enables all :ref:`URL ` types supported by\n pySerial and that those involving the network are unencrypted and not\n protected against eavesdropping.\n\nTest your setup.\n Is the device not working as expected? Maybe it's time to check the\n connection before proceeding. :ref:`miniterm` from the :ref:`examples`\n can be used to open the serial port and do some basic tests.\n\n To test cables, connecting RX to TX (loop back) and typing some characters\n in :ref:`miniterm` is a simple test. When the characters are displayed\n on the screen, then at least RX and TX work (they still could be swapped\n though).\n\n\nFAQ\n===\nExample works in :ref:`miniterm` but not in script.\n The RTS and DTR lines are switched when the port is opened. This may cause\n some processing or reset on the connected device. In such a cases an\n immediately following call to :meth:`write` may not be received by the\n device.\n\n A delay after opening the port, before the first :meth:`write`, is\n recommended in this situation. E.g. a ``time.sleep(1)``\n\n\nApplication works when .py file is run, but fails when packaged (py2exe etc.)\n py2exe and similar packaging programs scan the sources for import\n statements and create a list of modules that they package. pySerial may\n create two issues with that:\n\n - implementations for other modules are found. On Windows, it's safe to\n exclude 'serialposix', 'serialjava' and 'serialcli' as these are not\n used.\n\n - :func:`serial.serial_for_url` does a dynamic lookup of protocol handlers\n at runtime. If this function is used, the desired handlers have to be\n included manually (e.g. 'serial.urlhandler.protocol_socket',\n 'serial.urlhandler.protocol_rfc2217', etc.). This can be done either with\n the \"includes\" option in ``setup.py`` or by a dummy import in one of the\n packaged modules.\n\nUser supplied URL handlers\n :func:`serial.serial_for_url` can be used to access \"virtual\" serial ports\n identified by an :ref:`URL ` scheme. E.g. for the :rfc:`2217`:\n ``rfc2217:://``.\n\n Custom :ref:`URL ` handlers can be added by extending the module\n search path in :data:`serial.protocol_handler_packages`. This is possible\n starting from pySerial V2.6.\n\n\nRelated software\n================\n\ncom0com - http://com0com.sourceforge.net/\n Provides virtual serial ports for Windows.\n\n\nLicense\n=======\n\nCopyright (C) 2001-2011 Chris Liechti ;\nAll Rights Reserved.\n\nThis is the Python license. In short, you can use this product in commercial\nand non-commercial applications, modify it, redistribute it. A notification to\nthe author when you use and/or modify it is welcome.\n\n\n**TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING THIS SOFTWARE**\n\n*LICENSE AGREEMENT*\n\n1. This LICENSE AGREEMENT is between the copyright holder of this product, and\n the Individual or Organization (\"Licensee\") accessing and otherwise using\n this product in source or binary form and its associated documentation.\n\n2. Subject to the terms and conditions of this License Agreement, the copyright\n holder hereby grants Licensee a nonexclusive, royalty-free, world-wide\n license to reproduce, analyze, test, perform and/or display publicly,\n prepare derivative works, distribute, and otherwise use this product alone\n or in any derivative version, provided, however, that copyright holders\n License Agreement and copyright holders notice of copyright are retained in\n this product alone or in any derivative version prepared by Licensee.\n\n3. In the event Licensee prepares a derivative work that is based on or\n incorporates this product or any part thereof, and wants to make the\n derivative work available to others as provided herein, then Licensee hereby\n agrees to include in any such work a brief summary of the changes made to\n this product.\n\n4. The copyright holder is making this product available to Licensee on an \"AS\n IS\" basis. THE COPYRIGHT HOLDER MAKES NO REPRESENTATIONS OR WARRANTIES,\n EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, THE COPYRIGHT\n HOLDER MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY OF\n MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF\n THIS PRODUCT WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.\n\n5. THE COPYRIGHT HOLDER SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF\n THIS PRODUCT FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS\n AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING THIS PRODUCT, OR\n ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.\n\n6. This License Agreement will automatically terminate upon a material breach\n of its terms and conditions.\n\n7. Nothing in this License Agreement shall be deemed to create any relationship\n of agency, partnership, or joint venture between the copyright holder and\n Licensee. This License Agreement does not grant permission to use trademarks\n or trade names from the copyright holder in a trademark sense to endorse or\n promote products or services of Licensee, or any third party.\n\n8. By copying, installing or otherwise using this product, Licensee agrees to\n be bound by the terms and conditions of this License Agreement.\n\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/conf.py", "content": "# -*- coding: utf-8 -*-\n#\n# pySerial documentation build configuration file, created by\n# sphinx-quickstart on Tue Jul 21 00:27:45 2009.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys, os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#sys.path.append(os.path.abspath('.'))\n\n# -- General configuration -----------------------------------------------------\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.intersphinx']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'pySerial'\ncopyright = u'2001-2010, Chris Liechti'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '2.6'\n# The full version, including alpha/beta/rc tags.\nrelease = '2.6'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of documents that shouldn't be included in the build.\n#unused_docs = []\n\n# List of directories, relative to source directory, that shouldn't be searched\n# for source files.\nexclude_trees = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. Major themes that come with\n# Sphinx are currently 'default' and 'sphinxdoc'.\nhtml_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \" v documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\nhtml_logo = 'pyserial.png'\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_use_modindex = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# If nonempty, this is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = ''\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'pySerialdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\n# The paper size ('letter' or 'a4').\n#latex_paper_size = 'letter'\n\n# The font size ('10pt', '11pt' or '12pt').\n#latex_font_size = '10pt'\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'pySerial.tex', u'pySerial Documentation',\n u'Chris Liechti', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\nlatex_logo = 'pyserial.png'\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# Additional stuff for the LaTeX preamble.\n#latex_preamble = ''\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_use_modindex = True\n\n# for external links to standard library\nintersphinx_mapping = {\n #~ 'python': ('http://docs.python.org', None),\n 'py': ('http://docs.python.org', None),\n }\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/examples.rst", "content": ".. _examples:\n\n==========\n Examples\n==========\n\n.. _miniterm:\n\nMiniterm\n========\nThis is a console application that provides a small terminal application.\nMiniterm itself does not implement any terminal features such as VT102\ncompatibility. However it inherits these features from the terminal it is run.\nFor example on GNU/Linux running from an xterm it will support the escape\nsequences of the xterm. On Windows the typical console window is dumb and does\nnot support any escapes. When ANSI.sys is loaded it supports some escapes.\n\nMiniterm::\n\n --- Miniterm on /dev/ttyS0: 9600,8,N,1 ---\n --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---\n\nCommand line options can be given so that binary data including escapes for\nterminals are escaped or output as hex.\n\nMiniterm supports :rfc:`2217` remote serial ports and raw sockets using :ref:`URLs`\nsuch as ``rfc2217:://:`` respectively ``socket://:`` as\n*port* argument when invoking.\n\nCommand line options ``python -m serial.tools.miniterm -h``::\n\n Usage: miniterm.py [options] [port [baudrate]]\n\n Miniterm - A simple terminal program for the serial port.\n\n Options:\n -h, --help show this help message and exit\n -p PORT, --port=PORT port, a number (default 0) or a device name\n (deprecated option)\n -b BAUDRATE, --baud=BAUDRATE\n set baud rate, default 9600\n --parity=PARITY set parity, one of [N, E, O, S, M], default=N\n -e, --echo enable local echo (default off)\n --rtscts enable RTS/CTS flow control (default off)\n --xonxoff enable software flow control (default off)\n --cr do not send CR+LF, send CR only\n --lf do not send CR+LF, send LF only\n -D, --debug debug received data (escape non-printable chars)\n --debug can be given multiple times: 0: just print\n what is received 1: escape non-printable characters,\n do newlines as unusual 2: escape non-printable\n characters, newlines too 3: hex dump everything\n --rts=RTS_STATE set initial RTS line state (possible values: 0, 1)\n --dtr=DTR_STATE set initial DTR line state (possible values: 0, 1)\n -q, --quiet suppress non error messages\n --exit-char=EXIT_CHAR\n ASCII code of special character that is used to exit\n the application\n --menu-char=MENU_CHAR\n ASCII code of special character that is used to\n control miniterm (menu)\n\n\nMiniterm supports some control functions. Typing :kbd:`Ctrl+T Ctrl+H` when it is\nrunning shows the help text::\n\n --- pySerial - miniterm - help\n ---\n --- Ctrl+] Exit program\n --- Ctrl+T Menu escape key, followed by:\n --- Menu keys:\n --- Ctrl+T Send the menu character itself to remote\n --- Ctrl+] Send the exit character to remote\n --- Ctrl+I Show info\n --- Ctrl+U Upload file (prompt will be shown)\n --- Toggles:\n --- Ctrl+R RTS Ctrl+E local echo\n --- Ctrl+D DTR Ctrl+B BREAK\n --- Ctrl+L line feed Ctrl+A Cycle repr mode\n ---\n --- Port settings (Ctrl+T followed by the following):\n --- p change port\n --- 7 8 set data bits\n --- n e o s m change parity (None, Even, Odd, Space, Mark)\n --- 1 2 3 set stop bits (1, 2, 1.5)\n --- b change baud rate\n --- x X disable/enable software flow control\n --- r R disable/enable hardware flow control\n\n.. versionchanged:: 2.5\n Added :kbd:`Ctrl+T` menu and added support for opening URLs.\n.. versionchanged:: 2.6\n File moved from the examples to :mod:`serial.tools.miniterm`.\n\nminiterm.py_\n The miniterm program.\n\nsetup-miniterm-py2exe.py_\n This is a py2exe setup script for Windows. It can be used to create a\n standalone ``miniterm.exe``.\n\n.. _miniterm.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/serial/tools/miniterm.py\n.. _setup-miniterm-py2exe.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/setup-miniterm-py2exe.py\n\n\nTCP/IP - serial bridge\n======================\nThis program opens a TCP/IP port. When a connection is made to that port (e.g.\nwith telnet) it forwards all data to the serial port and vice versa.\n\nThis example only exports a raw socket connection. The next example\nbelow gives the client much more control over the remote serial port.\n\n- The serial port settings are set on the command line when starting the\n program.\n- There is no possibility to change settings from remote.\n- All data is passed through as-is.\n\n::\n\n Usage: tcp_serial_redirect.py [options] [port [baudrate]]\n\n Simple Serial to Network (TCP/IP) redirector.\n\n Options:\n -h, --help show this help message and exit\n -q, --quiet suppress non error messages\n --spy peek at the communication and print all data to the\n console\n\n Serial Port:\n Serial port settings\n\n -p PORT, --port=PORT\n port, a number (default 0) or a device name\n -b BAUDRATE, --baud=BAUDRATE\n set baud rate, default: 9600\n --parity=PARITY set parity, one of [N, E, O], default=N\n --rtscts enable RTS/CTS flow control (default off)\n --xonxoff enable software flow control (default off)\n --rts=RTS_STATE set initial RTS line state (possible values: 0, 1)\n --dtr=DTR_STATE set initial DTR line state (possible values: 0, 1)\n\n Network settings:\n Network configuration.\n\n -P LOCAL_PORT, --localport=LOCAL_PORT\n local TCP port\n --rfc2217 allow control commands with Telnet extension RFC-2217\n\n Newline Settings:\n Convert newlines between network and serial port. Conversion is\n normally disabled and can be enabled by --convert.\n\n -c, --convert enable newline conversion (default off)\n --net-nl=NET_NEWLINE\n type of newlines that are expected on the network\n (default: LF)\n --ser-nl=SER_NEWLINE\n type of newlines that are expected on the serial port\n (default: CR+LF)\n\n NOTE: no security measures are implemented. Anyone can remotely connect to\n this service over the network. Only one connection at once is supported. When\n the connection is terminated it waits for the next connect.\n\n\ntcp_serial_redirect.py_\n Main program.\n\n.. _tcp_serial_redirect.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/tcp_serial_redirect.py\n\nSingle-port TCP/IP - serial bridge (RFC 2217)\n=============================================\nSimple cross platform :rfc:`2217` serial port server. It uses threads and is\nportable (runs on POSIX, Windows, etc).\n\n- The port settings and control lines (RTS/DTR) can be changed at any time\n using :rfc:`2217` requests. The status lines (DSR/CTS/RI/CD) are polled every\n second and notifications are sent to the client.\n- Telnet character IAC (0xff) needs to be doubled in data stream. IAC followed\n by an other value is interpreted as Telnet command sequence.\n- Telnet negotiation commands are sent when connecting to the server.\n- RTS/DTR are activated on client connect and deactivated on disconnect.\n- Default port settings are set again when client disconnects.\n\n::\n\n Usage: rfc2217_server.py [options] port\n\n RFC 2217 Serial to Network (TCP/IP) redirector.\n\n Options:\n -h, --help show this help message and exit\n -p LOCAL_PORT, --localport=LOCAL_PORT\n local TCP port\n\n NOTE: no security measures are implemented. Anyone can remotely connect to\n this service over the network. Only one connection at once is supported. When\n the connection is terminated it waits for the next connect.\n\n.. versionadded:: 2.5\n\nrfc2217_server.py_\n Main program.\n\nsetup-rfc2217_server-py2exe.py_\n This is a py2exe setup script for Windows. It can be used to create a\n standalone ``rfc2217_server.exe``.\n\n.. _rfc2217_server.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/rfc2217_server.py\n.. _setup-rfc2217_server-py2exe.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/setup-rfc2217_server-py2exe.py\n\n\nMulti-port TCP/IP - serial bridge (RFC 2217)\n============================================\nThis example implements a TCP/IP to serial port service that works with\nmultiple ports at once. It uses select, no threads, for the serial ports and\nthe network sockets and therefore runs on POSIX systems only.\n\n- Full control over the serial port with :rfc:`2217`.\n- Check existence of ``/tty/USB0...8``. This is done every 5 seconds using\n ``os.path.exists``.\n- Send zeroconf announcements when port appears or disappears (uses\n python-avahi and dbus). Service name: ``_serial_port._tcp``.\n- Each serial port becomes available as one TCP/IP server. e.g.\n ``/dev/ttyUSB0`` is reachable at ``:7000``.\n- Single process for all ports and sockets (not per port).\n- The script can be started as daemon.\n- Logging to stdout or when run as daemon to syslog.\n- Default port settings are set again when client disconnects.\n- modem status lines (CTS/DSR/RI/CD) are not polled periodically and the server\n therefore does not send NOTIFY_MODEMSTATE on its own. However it responds to\n request from the client (i.e. use the ``poll_modem`` option in the URL when\n using a pySerial client.)\n\nRequirements:\n\n- Python (>= 2.4)\n- python-avahi\n- python-dbus\n- python-serial (>= 2.5)\n\nInstallation as daemon:\n\n- Copy the script ``port_publisher.py`` to ``/usr/local/bin``.\n- Copy the script ``port_publisher.sh`` to ``/etc/init.d``.\n- Add links to the runlevels using ``update-rc.d port_publisher.sh defaults 99``\n- Thats it :-) the service will be started on next reboot. Alternatively run\n ``invoke-rc.d port_publisher.sh start`` as root.\n\n.. versionadded:: 2.5 new example\n\nport_publisher.py_\n Multi-port TCP/IP-serial converter (RFC 2217) for POSIX environments.\n\nport_publisher.sh_\n Example init.d script.\n\n.. _port_publisher.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/port_publisher.py\n.. _port_publisher.sh: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/port_publisher.sh\n\n\nwxPython examples\n=================\nA simple terminal application for wxPython and a flexible serial port\nconfiguration dialog are shown here.\n\nwxTerminal.py_\n A simple terminal application. Note that the length of the buffer is\n limited by wx and it may suddenly stop displaying new input.\n\nwxTerminal.wxg_\n A wxGlade design file for the terminal application.\n\nwxSerialConfigDialog.py_\n A flexible serial port configuration dialog.\n\nwxSerialConfigDialog.wxg_\n The wxGlade design file for the configuration dialog.\n\nsetup-wxTerminal-py2exe.py_\n A py2exe setup script to package the terminal application.\n\n.. _wxTerminal.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/wxTerminal.py\n.. _wxTerminal.wxg: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/wxTerminal.wxg\n.. _wxSerialConfigDialog.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/wxSerialConfigDialog.py\n.. _wxSerialConfigDialog.wxg: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/wxSerialConfigDialog.wxg\n.. _setup-wxTerminal-py2exe.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/setup-wxTerminal-py2exe.py\n\n\nWrapper class\n=============\nThis example provides a subclass based on ``Serial`` that has an alternative\nimplementation of ``readline()``\n\nenhancedserial.py_\n A class with alternative ``readline()`` implementation.\n\n.. _enhancedserial.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/enhancedserial.py\n\n\nUnit tests\n==========\nThe project uses a number of unit test to verify the functionality. They all\nneed a loop back connector. The scripts itself contain more information. All\ntest scripts are contained in the directory ``test``.\n\nThe unit tests are performed on port ``0`` unless a different device name or\n``rfc2217://`` URL is given on the command line (argv[1]).\n\nrun_all_tests.py_\n Collect all tests from all ``test*`` files and run them. By default, the\n ``loop://`` device is used.\n\ntest.py_\n Basic tests (binary capabilities, timeout, control lines).\n\ntest_advanced.py_\n Test more advanced features (properties).\n\ntest_high_load.py_\n Tests involving sending a lot of data.\n\ntest_readline.py_\n Tests involving readline.\n\ntest_iolib.py_\n Tests involving the :mod:`io` library. Only available for Python 2.6 and\n newer.\n\ntest_url.py_\n Tests involving the :ref:`URL ` feature.\n\n.. _run_all_tests.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/run_all_tests.py\n.. _test.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/test.py\n.. _test_advanced.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/test_advanced.py\n.. _test_high_load.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/test_high_load.py\n.. _test_readline.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/test_readline.py\n.. _test_iolib.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/test_iolib.py\n.. _test_url.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/test/test_url.py\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/index.rst", "content": ".. pySerial documentation master file\n\nWelcome to pySerial's documentation\n===================================\n\nThis module encapsulates the access for the serial port. It provides backends\nfor Python running on Windows, Linux, BSD (possibly any POSIX compliant\nsystem), Jython and IronPython (.NET and Mono). The module named \"serial\"\nautomatically selects the appropriate backend.\n\nOther pages (online)\n\n- `project page on SourceForge`_\n- `SVN repository`_\n- `Download Page`_ with releases\n- This page, when viewed online, is at http://pyserial.sf.net.\n\n.. _`project page on SourceForge`: http://sourceforge.net/projects/pyserial/\n.. _`SVN repository`: http://sourceforge.net/svn/?group_id=46487\n.. _`Download Page`: http://pypi.python.org/pypi/pyserial\n\n\nContents:\n\n.. toctree::\n :maxdepth: 2\n\n pyserial\n shortintro\n examples\n pyserial_api\n pyparallel\n appendix\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/pyparallel.rst", "content": "============\n pyParallel\n============\n\n.. note:: This module is in development (since years ;-)\n\nOverview\n========\nThis module encapsulates the access for the parallel port. It provides backends\nfor Python running on Windows and Linux. Other platforms are possible too but\nnot yet integrated.\n\nThis module is still under development. But it may be useful for developers.\n\nCopyright (C) 2001-2003 Chris Liechti \n\nHere is the `project page on SourceForge`_ and here is the `SVN repository`_.\n\n.. _`project page on SourceForge`: http://sourceforge.net/projects/pyserial/\n.. _`SVN repository`: http://sourceforge.net/svn/?group_id=46487\n\n\nFeatures\n--------\n* same class based interface on all supported platforms\n* port numbering starts at zero, no need to know the port name in the user program\n* port string (device name) can be specified if access through numbering is inappropriate\n\n\nRequirements\n------------\n* Python 2.2 or newer\n* \"Java Communications\" (JavaComm) extension for Java/Jython\n\n\nInstallation\n------------\nExtract files from the archive, open a shell/console in that directory and let\nDistutils do the rest: ``python setup.py install``\n\nThe files get installed in the \"Lib/site-packages\" directory in newer Python versions.\n\nThe windows version needs a compiled extension and the giveio.sys driver for\nWindows NT/2k/XP. The extension module can be compiled with Distutils with\neither MSVC or GCC/mingw32.\n\nIt is released under a free software license, see LICENSE.txt for more details.\n\n\nShort introduction\n==================\n::\n\n >>> import parallel\n >>> p = parallel.Parallel() # open LPT1\n >>> p.setData(0x55)\n\n\nExamples\n--------\nPlease look in the SVN Repository. There is an example directory where you can\nfind a simple terminal and more.\nhttp://pyserial.svn.sourceforge.net/viewvc/pyserial/trunk/pyparallel/examples/\n\n\nAPI\n===\n\n.. module:: parallel\n\n.. class:: Parallel\n\n .. method:: __init__(port)\n\n Open given parallel port.\n\n .. method:: setData(value)\n\n Apply the given byte to the data pins of the parallel port.\n\n .. method:: setDataStrobe(level)\n\n Set the \"data strobe\" line to the given state.\n\n .. method:: setAutoFeed(level)\n\n Set \"auto feed\" line to given state.\n\n .. method:: setInitOut(level)\n\n Set \"initialize\" line to given state.\n\n .. method: setSelect(level)\n\n Set \"select\" line to given state.\n\n .. method:getInError()\n\n Set \"Error\" line to given state.\n\n .. method:: getInSelected()\n\n Read level of \"select\" line.\n\n .. method:: getInPaperOut()\n\n Read level of \"paper out\" line.\n\n .. method:: getInAcknowledge()\n\n Read level of \"Acknowledge\" line.\n\n .. method: getInBusy()\n\n Read level of \"busy\" line.\n\n\n.. module:: parallel.parallelutil\n\n.. class:: BitaccessMeta\n\n This mix-in class adds a few properties that allow easier bit access to the\n data lines. (D0 .. D7) e.g. p.D0 refers to the first bit of the data\n lines.\n\n.. class:: VirtualParallelPort\n\n This class provides a virtual parallel port implementation, useful\n for tests and simulations without real hardware.\n\n\nNotes\n=====\n\nLinux\n-----\n1. The :manpage:`lp(4)` module must be unloaded, ``rmmod lp``. ``lp`` claims\n exclusive access to the port and other programs won't be able to use it.\n\n2. The :manpage:`ppdev(4)` module needs to be loaded, ``modprobe ppdev``. When\n ``udev`` is in use, (default with 2.6 kernels) this will create a\n ``/dev/parport0``.\n\n3. The user needs to have write permissions to ``/dev/parport0``. Many\n distributions have an ``lp`` group that owns the device; the simplest is to\n add the user account to this group. Simply changing permissions on the\n device is not the best strategy as they will be reverted to their defaults\n next time the driver is loaded.\n\n\nWindows\n-------\nThe giveio driver must be installed as the module needs direct access to the\nhardware. This also means that USB parallel port adapters won't be supported.\n\n\nMisc\n====\nReferences\n----------\n* Python: http://www.python.org/\n* Jython: http://www.jython.org/\n* Java@IBM: http://www-106.ibm.com/developerworks/java/jdk/ (JavaComm links are\n on the download page for the respective platform JDK)\n* Java@SUN: http://java.sun.com/products/\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/pyserial.rst", "content": "==========\n pySerial\n==========\n\nOverview\n========\nThis module encapsulates the access for the serial port. It provides backends\nfor Python running on Windows, Linux, BSD (possibly any POSIX compliant\nsystem), Jython and IronPython (.NET and Mono). The module named \"serial\"\nautomatically selects the appropriate backend.\n\nIt is released under a free software license, see LICENSE_ for more\ndetails.\n\nCopyright (C) 2001-2010 Chris Liechti \n\nOther pages (online)\n\n- `project page on SourceForge`_\n- `SVN repository`_\n- `Download Page`_ with releases\n- This page, when viewed online is at http://pyserial.sf.net.\n\n.. _LICENSE: appendix.html#license\n.. _`project page on SourceForge`: http://sourceforge.net/projects/pyserial/\n.. _`SVN repository`: http://sourceforge.net/svn/?group_id=46487\n.. _`Download Page`: http://sourceforge.net/project/showfiles.php?group_id=46487\n\n\nFeatures\n========\n- Same class based interface on all supported platforms.\n- Access to the port settings through Python properties.\n- Support for different byte sizes, stop bits, parity and flow control with\n RTS/CTS and/or Xon/Xoff.\n- Working with or without receive timeout.\n- File like API with \"read\" and \"write\" (\"readline\" etc. also supported).\n- The files in this package are 100% pure Python.\n- The port is set up for binary transmission. No NULL byte stripping, CR-LF\n translation etc. (which are many times enabled for POSIX.) This makes this\n module universally useful.\n- Compatible with :mod:`io` library (Python 2.6+)\n- RFC 2217 client (experimental), server provided in the examples.\n\n\nRequirements\n============\n- Python 2.3 or newer, including Python 3.x\n- ctypes extensions on Windows (is in standard library since Python 2.5+)\n- \"Java Communications\" (JavaComm) or compatible extension for Java/Jython\n\n\nInstallation\n============\n\npyserial\n--------\nThis installs a package that can be used from Python (``import serial``).\n\nTo install the module for all users on the system, administrator rights (root)\nis required..\n\nFrom source (tar.gz or checkout)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nDownload the archive from http://pypi.python.org/pypi/pyserial.\nUnpack the archive, enter the ``pyserial-x.y`` directory and run::\n\n python setup.py install\n\nFor Python 3.x::\n\n python3 setup.py install\n\nFrom PyPI\n~~~~~~~~~\nAlternatively it can be installed from PyPI, either manually downloading the\nfiles and installing as described above or using::\n\n pip pyserial\n\nor::\n\n easy_install -U pyserial\n\nPackages\n~~~~~~~~\nThere are also packaged versions for some Linux distributions and Windows:\n\nDebian/Ubuntu\n A package is available under the name \"python-serial\". Note that some\n distributions package an older version of pySerial.\n\nWindows\n There is also a Windows installer for end users. It is located in the\n PyPi_. Developers may be interested to get the source archive, because it\n contains examples and the readme.\n\n.. _PyPi: http://pypi.python.org/pypi/pyserial\n\n\nReferences\n==========\n* Python: http://www.python.org/\n* Jython: http://www.jython.org/\n* Java@IBM: http://www-106.ibm.com/developerworks/java/jdk/ (JavaComm links are\n on the download page for the respective platform JDK)\n* Java@SUN: http://java.sun.com/products/\n* IronPython: http://www.codeplex.com/IronPython\n* setuptools: http://peak.telecommunity.com/DevCenter/setuptools\n\n\nOlder Versions\n==============\nOlder versions are still available on the `Download Page`_. pySerial 1.21 is\ncompatible with Python 2.0 on Windows, Linux and several un*x like systems,\nMacOSX and Jython.\n\nOn windows releases older than 2.5 will depend on pywin32_ (previously known as\nwin32all)\n\n.. _`Download Page`: http://sourceforge.net/project/showfiles.php?group_id=46487\n.. _pywin32: http://pypi.python.org/pypi/pywin32\n" }, { "path": "ICARUS-LX150/MiningSoftware/pyserial-2.6/documentation/pyserial_api.rst", "content": "==============\n pySerial API\n==============\n\n.. module:: serial\n\nClasses\n=======\n\nNative ports\n------------\n\n.. class:: Serial\n\n .. method:: __init__(port=None, baudrate=9600, bytesize=EIGHTBITS, parity=PARITY_NONE, stopbits=STOPBITS_ONE, timeout=None, xonxoff=False, rtscts=False, writeTimeout=None, dsrdtr=False, interCharTimeout=None)\n\n :param port:\n Device name or port number number or :const:`None`.\n\n :param baudrate:\n Baud rate such as 9600 or 115200 etc.\n\n :param bytesize:\n Number of data bits. Possible values:\n :const:`FIVEBITS`, :const:`SIXBITS`, :const:`SEVENBITS`,\n :const:`EIGHTBITS`\n\n :param parity:\n Enable parity checking. Possible values:\n :const:`PARITY_NONE`, :const:`PARITY_EVEN`, :const:`PARITY_ODD`\n :const:`PARITY_MARK`, :const:`PARITY_SPACE`\n\n :param stopbits:\n Number of stop bits. Possible values:\n :const:`STOPBITS_ONE`, :const:`STOPBITS_ONE_POINT_FIVE`,\n :const:`STOPBITS_TWO`\n\n :param timeout:\n Set a read timeout value.\n\n :param xonxoff:\n Enable software flow control.\n\n :param rtscts:\n Enable hardware (RTS/CTS) flow control.\n\n :param dsrdtr:\n Enable hardware (DSR/DTR) flow control.\n\n :param writeTimeout:\n Set a write timeout value.\n\n :param interCharTimeout:\n Inter-character timeout, :const:`None` to disable (default).\n\n :exception ValueError:\n Will be raised when parameter are out of range, e.g. baud rate, data bits.\n\n :exception SerialException:\n In case the device can not be found or can not be configured.\n\n\n The port is immediately opened on object creation, when a *port* is\n given. It is not opened when *port* is :const:`None` and a successive call\n to :meth:`open` will be needed.\n\n Possible values for the parameter *port*:\n\n - Number: number of device, numbering starts at zero.\n - Device name: depending on operating system. e.g. ``/dev/ttyUSB0``\n on GNU/Linux or ``COM3`` on Windows.\n\n The parameter *baudrate* can be one of the standard values:\n 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800,\n 9600, 19200, 38400, 57600, 115200.\n These are well supported on all platforms. Standard values above 115200\n such as: 230400, 460800, 500000, 576000, 921600, 1000000, 1152000,\n 1500000, 2000000, 2500000, 3000000, 3500000, 4000000 also work on many\n platforms.\n\n Non-standard values are also supported on some platforms (GNU/Linux, MAC\n OSX >= Tiger, Windows). Though, even on these platforms some serial\n ports may reject non-standard values.\n\n Possible values for the parameter *timeout*:\n\n - ``timeout = None``: wait forever\n - ``timeout = 0``: non-blocking mode (return immediately on read)\n - ``timeout = x``: set timeout to ``x`` seconds (float allowed)\n\n Writes are blocking by default, unless *writeTimeout* is set. For\n possible values refer to the list for *timeout* above.\n\n Note that enabling both flow control methods (*xonxoff* and *rtscts*)\n together may not be supported. It is common to use one of the methods\n at once, not both.\n\n *dsrdtr* is not supported by all platforms (silently ignored). Setting\n it to ``None`` has the effect that its state follows *rtscts*.\n\n Also consider using the function :func:`serial_for_url` instead of\n creating Serial instances directly.\n\n .. versionchanged:: 2.5\n *dsrdtr* now defaults to ``False`` (instead of *None*)\n\n .. method:: open()\n\n Open port.\n\n .. method:: close()\n\n Close port immediately.\n\n .. method:: __del__()\n\n Destructor, close port when serial port instance is freed.\n\n\n The following methods may raise :exc:`ValueError` when applied to a closed\n port.\n\n .. method:: read(size=1)\n\n :param size: Number of bytes to read.\n :return: Bytes read from the port.\n\n Read *size* bytes from the serial port. If a timeout is set it may\n return less characters as requested. With no timeout it will block\n until the requested number of bytes is read.\n\n .. versionchanged:: 2.5\n Returns an instance of :class:`bytes` when available (Python 2.6\n and newer) and :class:`str` otherwise.\n\n .. method:: write(data)\n\n :param data: Data to send.\n :return: Number of bytes written.\n :exception SerialTimeoutException:\n In case a write timeout is configured for the port and the time is\n exceeded.\n\n Write the string *data* to the port.\n\n .. versionchanged:: 2.5\n Accepts instances of :class:`bytes` and :class:`bytearray` when\n available (Python 2.6 and newer) and :class:`str` otherwise.\n\n .. versionchanged:: 2.5\n Write returned ``None`` in previous versions.\n\n .. method:: inWaiting()\n\n Return the number of chars in the receive buffer.\n\n .. method:: flush()\n\n Flush of file like objects. In this case, wait until all data is\n written.\n\n .. method:: flushInput()\n\n Flush input buffer, discarding all it's contents.\n\n .. method:: flushOutput()\n\n Clear output buffer, aborting the current output and\n discarding all that is in the buffer.\n\n .. method:: sendBreak(duration=0.25)\n\n :param duration: Time (float) to activate the BREAK condition.\n\n Send break condition. Timed, returns to idle state after given\n duration.\n\n .. method:: setBreak(level=True)\n\n :param level: when true activate BREAK condition, else disable.\n\n Set break: Controls TXD. When active, no transmitting is possible.\n\n .. method:: setRTS(level=True)\n\n :param level: Set control line to logic level.\n\n Set RTS line to specified logic level.\n\n .. method:: setDTR(level=True)\n\n :param level: Set control line to logic level.\n\n Set DTR line to specified logic level.\n\n .. method:: getCTS()\n\n :return: Current state (boolean)\n\n Return the state of the CTS line.\n\n .. method:: getDSR()\n\n :return: Current state (boolean)\n\n Return the state of the DSR line.\n\n .. method:: getRI()\n\n :return: Current state (boolean)\n\n Return the state of the RI line.\n\n .. method:: getCD()\n\n :return: Current state (boolean)\n\n Return the state of the CD line\n\n Read-only attributes:\n\n .. attribute:: name\n\n Device name. This is always the device name even if the\n port was opened by a number. (Read Only).\n\n .. versionadded:: 2.5\n\n .. attribute:: portstr\n\n :deprecated: use :attr:`name` instead\n\n New values can be assigned to the following attributes (properties), the\n port will be reconfigured, even if it's opened at that time:\n\n\n .. attribute:: port\n\n Read or write port. When the port is already open, it will be closed\n and reopened with the new setting.\n\n .. attribute:: baudrate\n\n Read or write current baud rate setting.\n\n .. attribute:: bytesize\n\n Read or write current data byte size setting.\n\n .. attribute:: parity\n\n Read or write current parity setting.\n\n .. attribute:: stopbits\n\n Read or write current stop bit width setting.\n\n .. attribute:: timeout\n\n Read or write current read timeout setting.\n\n .. attribute:: writeTimeout\n\n Read or write current write timeout setting.\n\n .. attribute:: xonxoff\n\n Read or write current software flow control rate setting.\n\n .. attribute:: rtscts\n\n Read or write current hardware flow control setting.\n\n .. attribute:: dsrdtr\n\n Read or write current hardware flow control setting.\n\n .. attribute:: interCharTimeout\n\n Read or write current inter character timeout setting.\n\n The following constants are also provided:\n\n .. attribute:: BAUDRATES\n\n A list of valid baud rates. The list may be incomplete such that higher\n baud rates may be supported by the device and that values in between the\n standard baud rates are supported. (Read Only).\n\n .. attribute:: BYTESIZES\n\n A list of valid byte sizes for the device (Read Only).\n\n .. attribute:: PARITIES\n\n A list of valid parities for the device (Read Only).\n\n .. attribute:: STOPBITS\n\n A list of valid stop bit widths for the device (Read Only).\n\n\n The following methods are for compatibility with the :mod:`io` library.\n\n .. method:: readable()\n\n :return: True\n\n .. versionadded:: 2.5\n\n .. method:: writable()\n\n :return: True\n\n .. versionadded:: 2.5\n\n .. method:: seekable()\n\n :return: False\n\n .. versionadded:: 2.5\n\n .. method:: readinto(b)\n\n :param b: bytearray or array instance\n :return: Number of byte read\n\n Read up to len(b) bytes into :class:`bytearray` *b* and return the\n number of bytes read.\n\n .. versionadded:: 2.5\n\n The port settings can be read and written as dictionary.\n\n .. method:: getSettingsDict()\n\n :return: a dictionary with current port settings.\n\n Get a dictionary with port settings. This is useful to backup the\n current settings so that a later point in time they can be restored\n using :meth:`applySettingsDict`.\n\n Note that control lines (RTS/DTR) are part of the settings.\n\n .. versionadded:: 2.5\n\n .. method:: applySettingsDict(d)\n\n :param d: a dictionary with port settings.\n\n Applies a dictionary that was created by :meth:`getSettingsDict`. Only\n changes are applied and when a key is missing it means that the setting\n stays unchanged.\n\n Note that control lines (RTS/DTR) are not changed.\n\n .. versionadded:: 2.5\n\n Platform specific methods.\n\n .. warning:: Programs using the following methods are not portable to other platforms!\n\n .. method:: nonblocking()\n\n :platform: Unix\n\n Configure the device for nonblocking operation. This can be useful if\n the port is used with :mod:`select`.\n\n .. method:: fileno()\n\n :platform: Unix\n :return: File descriptor.\n\n Return file descriptor number for the port that is opened by this object.\n It is useful when serial ports are used with :mod:`select`.\n\n .. method:: setXON(level=True)\n\n :platform: Windows\n :param level: Set flow control state.\n\n Set software flow control state.\n\n.. note::\n\n For systems that provide the :py:mod:`io` library (Python 2.6 and newer), the\n class :class:`Serial` will derive from :py:class:`io.RawIOBase`. For all\n others from :class:`FileLike`.\n\nImplementation detail: some attributes and functions are provided by the\nclass :class:`SerialBase` and some by the platform specific class and\nothers by the base class mentioned above.\n\n.. class:: FileLike\n\n An abstract file like class. It is used as base class for :class:`Serial`\n when no :py:mod:`io` module is available.\n\n This class implements :meth:`readline` and :meth:`readlines` based on\n :meth:`read` and :meth:`writelines` based on :meth:`write`.\n\n Note that when the serial port was opened with no timeout, that\n :meth:`readline` blocks until it sees a newline (or the specified size is\n reached) and that :meth:`readlines` would never return and therefore\n refuses to work (it raises an exception in this case)!\n\n .. method:: writelines(sequence)\n\n Write a list of strings to the port.\n\n\n The following three methods are overridden in :class:`Serial`.\n\n .. method:: flush()\n\n Flush of file like objects. It's a no-op in this class, may be overridden.\n\n .. method:: read()\n\n Raises NotImplementedError, needs to be overridden by subclass.\n\n .. method:: write(data)\n\n Raises NotImplementedError, needs to be overridden by subclass.\n\n The following functions are implemented for compatibility with other\n file-like objects, however serial ports are not seekable.\n\n\n .. method:: seek(pos, whence=0)\n\n :exception IOError: always, as method is not supported on serial port\n\n .. versionadded:: 2.5\n\n .. method:: tell()\n\n :exception IOError: always, as method is not supported on serial port\n\n .. versionadded:: 2.5\n\n .. method:: truncate(self, n=None)\n\n :exception IOError: always, as method is not supported on serial port\n\n .. versionadded:: 2.5\n\n .. method:: isatty()\n\n :exception IOError: always, as method is not supported on serial port\n\n .. versionadded:: 2.5\n\n To be able to use the file like object as iterator for e.g.\n ``for line in Serial(0): ...`` usage:\n\n .. method:: next()\n\n Return the next line by calling :meth:`readline`.\n\n .. method:: __iter__()\n\n Returns self.\n\n Other high level access functions.\n\n .. method:: readline(size=None, eol='\\\\n')\n\n :param size: Max number of bytes to read, ``None`` -> no limit.\n :param eol: The end of line character.\n\n Read a line which is terminated with end-of-line (*eol*) character\n (``\\n`` by default) or until timeout.\n\n .. method:: readlines(sizehint=None, eol='\\\\n')\n\n :param sizehint: Ignored parameter.\n :param eol: The end of line character.\n\n Read a list of lines, until timeout. *sizehint* is ignored and only\n present for API compatibility with built-in File objects.\n\n Note that this function only returns on a timeout.\n\n .. method:: xreadlines(sizehint=None)\n\n Read lines, implemented as generator. Unlike *readlines* (that only\n returns on a timeout) is this function yielding lines as they are\n received.\n\n .. deprecated:: 2.5\n Use ``for line in Serial(...): ...`` instead. This method is not\n available in Python 2.6 and newer where the :mod:`io` library is\n available and pySerial bases on it.\n\n .. versionchanged:: 2.5\n Implement as generator.\n\n\n:rfc:`2217` Network ports\n-------------------------\n\n.. warning:: This implementation is currently in an experimental state. Use\n at your own risk.\n\n.. class:: rfc2217.Serial\n\n This implements a :rfc:`2217` compatible client. Port names are URLs_ in the\n form: ``rfc2217://:[/