├── .gitignore ├── CircularZone ├── CircularZone.py ├── CircularZoneDlg.fbp ├── CircularZoneDlg.py ├── __init__.py ├── round_keepout_area.png └── round_keepout_area.svg ├── LICENSE.md ├── README.md ├── ViaStitching ├── FillArea.py ├── FillAreaAction.py ├── FillAreaDialog.py ├── FillAreaTpl.fbp ├── __init__.py ├── stitching-vias-help.png ├── stitching-vias-help.svg ├── stitching-vias.png └── stitching-vias.svg └── images ├── circular1.png ├── circular2.png ├── circular3.png ├── circular4.png ├── via1.png └── via2.png /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | -------------------------------------------------------------------------------- /CircularZone/CircularZone.py: -------------------------------------------------------------------------------- 1 | from math import * 2 | import pcbnew 3 | from .CircularZoneDlg import CircularZoneDlg 4 | import wx 5 | import os 6 | 7 | 8 | class CircularZone(pcbnew.ActionPlugin): 9 | 10 | def defaults(self): 11 | self.name = "Circular Zone\nKeepout Zone Generator" 12 | self.category = "Modify PCB" 13 | self.description = "Create a Circular Zone\nor a Circular Keepout Zone" 14 | self.icon_file_name = os.path.join(os.path.dirname(__file__), "./round_keepout_area.png") 15 | self.show_toolbar_button = True 16 | 17 | def build(self, center_x, center_y, radius, keepout, edge_count): 18 | sp = pcbnew.SHAPE_POLY_SET() 19 | sp.NewOutline() 20 | cnt = edge_count 21 | for i in range(cnt): 22 | x = int(center_x + radius * cos(i * 2 * pi / cnt)) 23 | y = int(center_y + radius * sin(i * 2 * pi / cnt)) 24 | sp.Append(x, y) 25 | # sp.OutlineCount() 26 | sp.thisown = 0 27 | zone = pcbnew.ZONE_CONTAINER(self.pcb) 28 | zone.SetOutline(sp) 29 | zone.SetLayer(pcbnew.F_Cu) 30 | zone.SetIsKeepout(keepout) 31 | zone.thisown = 0 32 | self.pcb.Add(zone) 33 | 34 | def Warn(self, message, caption='Warning!'): 35 | dlg = wx.MessageDialog( 36 | None, message, caption, wx.OK | wx.ICON_WARNING) 37 | dlg.ShowModal() 38 | dlg.Destroy() 39 | 40 | def CheckInput(self, value, data): 41 | val = None 42 | try: 43 | val = int(value) 44 | if val < 1: 45 | raise Exception("Invalid") 46 | except: 47 | self.Warn( 48 | "Invalid parameter for %s: Must be a positive number" % data) 49 | val = None 50 | return val 51 | 52 | def Run(self): 53 | self.pcb = pcbnew.GetBoard() 54 | a = CircularZoneDlg(None) 55 | x = 0 56 | y = 0 57 | reference = None 58 | for module in self.pcb.GetModules(): 59 | if module.IsSelected(): 60 | x = module.GetPosition().x 61 | y = module.GetPosition().y 62 | reference = module.GetReference() 63 | break 64 | if reference is None: 65 | a.m_comment.SetLabel("No reference position: start at origin") 66 | else: 67 | a.m_comment.SetLabel("Using %s as position reference" % reference) 68 | 69 | a.m_radiusMM.SetValue("10") 70 | modal_result = a.ShowModal() 71 | 72 | segment = self.CheckInput( 73 | a.m_textCtrl_seg.GetValue(), "segment number") 74 | radius = self.CheckInput(a.m_radiusMM.GetValue(), "radius") 75 | 76 | if segment is not None and radius is not None: 77 | if modal_result == wx.ID_OK: 78 | self.build(x, y, pcbnew.FromMM( 79 | radius), a.m_radio_out.GetValue(), segment) 80 | else: 81 | None # Cancel 82 | else: 83 | None # Invalid input 84 | a.Destroy() 85 | -------------------------------------------------------------------------------- /CircularZone/CircularZoneDlg.fbp: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Python 7 | 1 8 | source_name 9 | 0 10 | 0 11 | res 12 | UTF-8 13 | connect 14 | CircularZoneDlg 15 | 1000 16 | none 17 | 0 18 | CircularZoneDlg 19 | 20 | . 21 | 22 | 1 23 | 1 24 | 1 25 | 1 26 | UI 27 | 0 28 | 0 29 | 30 | 0 31 | wxAUI_MGR_DEFAULT 32 | 33 | wxBOTH 34 | 35 | 1 36 | 1 37 | impl_virtual 38 | 39 | 40 | 41 | 0 42 | wxID_ANY 43 | 44 | 45 | CircularZoneDlg 46 | 47 | 373,290 48 | wxDEFAULT_DIALOG_STYLE 49 | 50 | Circular zone parameters 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | bSizer3 94 | wxVERTICAL 95 | none 96 | 97 | 5 98 | wxALL|wxEXPAND 99 | 0 100 | 101 | 1 102 | 1 103 | 1 104 | 1 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 1 113 | 0 114 | 1 115 | 116 | 1 117 | 0 118 | Dock 119 | 0 120 | Left 121 | 1 122 | 123 | 1 124 | 125 | 0 126 | 0 127 | wxID_ANY 128 | 129 | 130 | 0 131 | 132 | 133 | 0 134 | 135 | 1 136 | m_comment 137 | 1 138 | 139 | 140 | protected 141 | 1 142 | 143 | Resizable 144 | 1 145 | 146 | 147 | 148 | 0 149 | 150 | 151 | 152 | 153 | -1 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 5 181 | 182 | 0 183 | 184 | 185 | bSizer31 186 | wxHORIZONTAL 187 | none 188 | 189 | 5 190 | wxALL|wxEXPAND 191 | 1 192 | 193 | 1 194 | 1 195 | 1 196 | 1 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 1 205 | 0 206 | 1 207 | 208 | 1 209 | 0 210 | Dock 211 | 0 212 | Left 213 | 1 214 | 215 | 1 216 | 217 | 0 218 | 0 219 | wxID_ANY 220 | Radius (mm) 221 | 222 | 0 223 | 224 | 225 | 0 226 | 227 | 1 228 | m_staticText3 229 | 1 230 | 231 | 232 | protected 233 | 1 234 | 235 | Resizable 236 | 1 237 | 238 | 239 | 240 | 0 241 | 242 | 243 | 244 | 245 | -1 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 270 | 271 | 272 | 5 273 | wxALL|wxEXPAND 274 | 1 275 | 276 | 1 277 | 1 278 | 1 279 | 1 280 | 281 | 282 | 283 | 284 | 285 | 286 | 287 | 1 288 | 0 289 | 1 290 | 291 | 1 292 | 0 293 | Dock 294 | 0 295 | Left 296 | 1 297 | 298 | 1 299 | 300 | 0 301 | 0 302 | wxID_ANY 303 | 304 | 0 305 | 306 | 307 | 308 | 0 309 | 1000,-1 310 | 1 311 | m_radiusMM 312 | 1 313 | 314 | 315 | protected 316 | 1 317 | 318 | Resizable 319 | 1 320 | 321 | 322 | 323 | 0 324 | 325 | 326 | wxFILTER_NONE 327 | wxTextValidator 328 | 329 | 330 | 331 | 332 | 333 | 334 | 335 | 336 | 337 | 338 | 339 | 340 | 341 | 342 | 343 | 344 | 345 | 346 | 347 | 348 | 349 | 350 | 351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | 361 | 362 | 363 | 364 | 365 | 5 366 | wxEXPAND 367 | 1 368 | 369 | 370 | bSizer4 371 | wxHORIZONTAL 372 | none 373 | 374 | 5 375 | wxEXPAND 376 | 1 377 | 378 | wxID_ANY 379 | Type of Zone 380 | 381 | sbSizer1 382 | wxVERTICAL 383 | 1 384 | none 385 | 386 | 387 | 5 388 | wxALL|wxALIGN_CENTER_VERTICAL|wxEXPAND 389 | 0 390 | 391 | 1 392 | 1 393 | 1 394 | 1 395 | 396 | 397 | 398 | 399 | 400 | 401 | 402 | 1 403 | 0 404 | 1 405 | 406 | 1 407 | 0 408 | Dock 409 | 0 410 | Left 411 | 1 412 | 413 | 1 414 | 415 | 0 416 | 0 417 | wxID_ANY 418 | Standard 419 | 420 | 0 421 | 422 | 423 | 0 424 | 425 | 1 426 | m_radio_std 427 | 1 428 | 429 | 430 | protected 431 | 1 432 | 433 | Resizable 434 | 1 435 | 436 | 437 | 438 | 0 439 | 440 | 441 | wxFILTER_NONE 442 | wxDefaultValidator 443 | 444 | 0 445 | 446 | 447 | 448 | 449 | 450 | 451 | 452 | 453 | 454 | 455 | 456 | 457 | 458 | 459 | 460 | 461 | 462 | 463 | 464 | 465 | 466 | 467 | 468 | 469 | 470 | 471 | 472 | 473 | 474 | 475 | 5 476 | wxALL|wxALIGN_CENTER_VERTICAL 477 | 0 478 | 479 | 1 480 | 1 481 | 1 482 | 1 483 | 484 | 485 | 486 | 487 | 488 | 489 | 490 | 1 491 | 0 492 | 1 493 | 494 | 1 495 | 0 496 | Dock 497 | 0 498 | Left 499 | 1 500 | 501 | 1 502 | 503 | 0 504 | 0 505 | wxID_ANY 506 | Keepout 507 | 508 | 0 509 | 510 | 511 | 0 512 | 513 | 1 514 | m_radio_out 515 | 1 516 | 517 | 518 | protected 519 | 1 520 | 521 | Resizable 522 | 1 523 | 524 | 525 | 526 | 0 527 | 528 | 529 | wxFILTER_NONE 530 | wxDefaultValidator 531 | 532 | 0 533 | 534 | 535 | 536 | 537 | 538 | 539 | 540 | 541 | 542 | 543 | 544 | 545 | 546 | 547 | 548 | 549 | 550 | 551 | 552 | 553 | 554 | 555 | 556 | 557 | 558 | 559 | 560 | 561 | 562 | 563 | 564 | 565 | 5 566 | wxEXPAND 567 | 1 568 | 569 | wxID_ANY 570 | Number of segments 571 | 572 | sbSizer2 573 | wxVERTICAL 574 | 1 575 | none 576 | 577 | 578 | 5 579 | wxALL|wxEXPAND 580 | 0 581 | 582 | 1 583 | 1 584 | 1 585 | 1 586 | 587 | 588 | 589 | 590 | 591 | 592 | 593 | 1 594 | 0 595 | 1 596 | 597 | 1 598 | 0 599 | Dock 600 | 0 601 | Left 602 | 1 603 | 604 | 1 605 | 606 | 0 607 | 0 608 | wxID_ANY 609 | 610 | 0 611 | 612 | 613 | 614 | 0 615 | 616 | 1 617 | m_textCtrl_seg 618 | 1 619 | 620 | 621 | protected 622 | 1 623 | 624 | Resizable 625 | 1 626 | 627 | 628 | 629 | 0 630 | 631 | 632 | wxFILTER_NONE 633 | wxDefaultValidator 634 | 635 | 64 636 | 637 | 638 | 639 | 640 | 641 | 642 | 643 | 644 | 645 | 646 | 647 | 648 | 649 | 650 | 651 | 652 | 653 | 654 | 655 | 656 | 657 | 658 | 659 | 660 | 661 | 662 | 663 | 664 | 665 | 666 | 667 | 668 | 669 | 670 | 671 | 672 | 673 | 5 674 | wxALIGN_RIGHT|wxEXPAND 675 | 0 676 | 677 | 678 | bSizer1 679 | wxHORIZONTAL 680 | none 681 | 682 | 5 683 | wxALL|wxEXPAND|wxALIGN_CENTER_VERTICAL 684 | 1 685 | 686 | 1 687 | 1 688 | 1 689 | 1 690 | 691 | 692 | 693 | 694 | 695 | 696 | 697 | 1 698 | 0 699 | 1 700 | 701 | 1 702 | 0 703 | Dock 704 | 0 705 | Left 706 | 1 707 | 708 | 1 709 | 710 | 0 711 | 0 712 | wxID_ANY 713 | 714 | 715 | 0 716 | 717 | 718 | 0 719 | 720 | 1 721 | m_staticText101 722 | 1 723 | 724 | 725 | protected 726 | 1 727 | 728 | Resizable 729 | 1 730 | 731 | 732 | 733 | 0 734 | 735 | 736 | 737 | 738 | -1 739 | 740 | 741 | 742 | 743 | 744 | 745 | 746 | 747 | 748 | 749 | 750 | 751 | 752 | 753 | 754 | 755 | 756 | 757 | 758 | 759 | 760 | 761 | 762 | 763 | 764 | 765 | 5 766 | wxALL|wxALIGN_CENTER_VERTICAL 767 | 0 768 | 769 | 1 770 | 1 771 | 1 772 | 1 773 | 774 | 775 | 776 | 777 | 778 | 779 | 780 | 1 781 | 0 782 | 0 783 | 784 | 1 785 | 1 786 | 0 787 | Dock 788 | 0 789 | Left 790 | 1 791 | 792 | 1 793 | 794 | 0 795 | 0 796 | wxID_OK 797 | Create 798 | 799 | 0 800 | 801 | 802 | 0 803 | 804 | 1 805 | m_button1 806 | 1 807 | 808 | 809 | protected 810 | 1 811 | 812 | Resizable 813 | 1 814 | 815 | 816 | 817 | 0 818 | 819 | 820 | wxFILTER_NONE 821 | wxDefaultValidator 822 | 823 | 824 | 825 | 826 | 827 | 828 | 829 | 830 | 831 | 832 | 833 | 834 | 835 | 836 | 837 | 838 | 839 | 840 | 841 | 842 | 843 | 844 | 845 | 846 | 847 | 848 | 849 | 850 | 851 | 852 | 853 | 5 854 | wxALL|wxALIGN_CENTER_VERTICAL 855 | 0 856 | 857 | 1 858 | 1 859 | 1 860 | 1 861 | 862 | 863 | 864 | 865 | 866 | 867 | 868 | 1 869 | 0 870 | 1 871 | 872 | 1 873 | 0 874 | 0 875 | Dock 876 | 0 877 | Left 878 | 1 879 | 880 | 1 881 | 882 | 0 883 | 0 884 | wxID_CANCEL 885 | Cancel 886 | 887 | 0 888 | 889 | 890 | 0 891 | 892 | 1 893 | m_button2 894 | 1 895 | 896 | 897 | protected 898 | 1 899 | 900 | Resizable 901 | 1 902 | 903 | 904 | 905 | 0 906 | 907 | 908 | wxFILTER_NONE 909 | wxDefaultValidator 910 | 911 | 912 | 913 | 914 | 915 | 916 | 917 | 918 | 919 | 920 | 921 | 922 | 923 | 924 | 925 | 926 | 927 | 928 | 929 | 930 | 931 | 932 | 933 | 934 | 935 | 936 | 937 | 938 | 939 | 940 | 941 | 942 | 943 | 944 | 945 | 946 | -------------------------------------------------------------------------------- /CircularZone/CircularZoneDlg.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | ########################################################################### 4 | ## Python code generated with wxFormBuilder (version Dec 21 2016) 5 | ## http://www.wxformbuilder.org/ 6 | ## 7 | ## PLEASE DO "NOT" EDIT THIS FILE! 8 | ########################################################################### 9 | 10 | import wx 11 | import wx.xrc 12 | 13 | ########################################################################### 14 | ## Class CircularZoneDlg 15 | ########################################################################### 16 | 17 | class CircularZoneDlg ( wx.Dialog ): 18 | 19 | def __init__( self, parent ): 20 | wx.Dialog.__init__ ( self, parent, id = wx.ID_ANY, title = u"Circular zone parameters", pos = wx.DefaultPosition, size = wx.Size( 373,290 ), style = wx.DEFAULT_DIALOG_STYLE ) 21 | 22 | self.SetSizeHintsSz( wx.DefaultSize, wx.DefaultSize ) 23 | 24 | bSizer3 = wx.BoxSizer( wx.VERTICAL ) 25 | 26 | self.m_comment = wx.StaticText( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 27 | self.m_comment.Wrap( -1 ) 28 | bSizer3.Add( self.m_comment, 0, wx.ALL|wx.EXPAND, 5 ) 29 | 30 | bSizer31 = wx.BoxSizer( wx.HORIZONTAL ) 31 | 32 | self.m_staticText3 = wx.StaticText( self, wx.ID_ANY, u"Radius (mm)", wx.DefaultPosition, wx.DefaultSize, 0 ) 33 | self.m_staticText3.Wrap( -1 ) 34 | bSizer31.Add( self.m_staticText3, 1, wx.ALL|wx.EXPAND, 5 ) 35 | 36 | self.m_radiusMM = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 37 | self.m_radiusMM.SetMinSize( wx.Size( 1000,-1 ) ) 38 | 39 | bSizer31.Add( self.m_radiusMM, 1, wx.ALL|wx.EXPAND, 5 ) 40 | 41 | 42 | bSizer3.Add( bSizer31, 0, 0, 5 ) 43 | 44 | bSizer4 = wx.BoxSizer( wx.HORIZONTAL ) 45 | 46 | sbSizer1 = wx.StaticBoxSizer( wx.StaticBox( self, wx.ID_ANY, u"Type of Zone" ), wx.VERTICAL ) 47 | 48 | self.m_radio_std = wx.RadioButton( sbSizer1.GetStaticBox(), wx.ID_ANY, u"Standard", wx.DefaultPosition, wx.DefaultSize, 0 ) 49 | sbSizer1.Add( self.m_radio_std, 0, wx.ALL|wx.ALIGN_CENTER_VERTICAL|wx.EXPAND, 5 ) 50 | 51 | self.m_radio_out = wx.RadioButton( sbSizer1.GetStaticBox(), wx.ID_ANY, u"Keepout", wx.DefaultPosition, wx.DefaultSize, 0 ) 52 | sbSizer1.Add( self.m_radio_out, 0, wx.ALL|wx.ALIGN_CENTER_VERTICAL, 5 ) 53 | 54 | 55 | bSizer4.Add( sbSizer1, 1, wx.EXPAND, 5 ) 56 | 57 | sbSizer2 = wx.StaticBoxSizer( wx.StaticBox( self, wx.ID_ANY, u"Number of segments" ), wx.VERTICAL ) 58 | 59 | self.m_textCtrl_seg = wx.TextCtrl( sbSizer2.GetStaticBox(), wx.ID_ANY, u"64", wx.DefaultPosition, wx.DefaultSize, 0 ) 60 | sbSizer2.Add( self.m_textCtrl_seg, 0, wx.ALL|wx.EXPAND, 5 ) 61 | 62 | 63 | bSizer4.Add( sbSizer2, 1, wx.EXPAND, 5 ) 64 | 65 | 66 | bSizer3.Add( bSizer4, 1, wx.EXPAND, 5 ) 67 | 68 | bSizer1 = wx.BoxSizer( wx.HORIZONTAL ) 69 | 70 | self.m_staticText101 = wx.StaticText( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 71 | self.m_staticText101.Wrap( -1 ) 72 | bSizer1.Add( self.m_staticText101, 1, wx.ALL|wx.EXPAND|wx.ALIGN_CENTER_VERTICAL, 5 ) 73 | 74 | self.m_button1 = wx.Button( self, wx.ID_OK, u"Create", wx.DefaultPosition, wx.DefaultSize, 0 ) 75 | self.m_button1.SetDefault() 76 | bSizer1.Add( self.m_button1, 0, wx.ALL|wx.ALIGN_CENTER_VERTICAL, 5 ) 77 | 78 | self.m_button2 = wx.Button( self, wx.ID_CANCEL, u"Cancel", wx.DefaultPosition, wx.DefaultSize, 0 ) 79 | bSizer1.Add( self.m_button2, 0, wx.ALL|wx.ALIGN_CENTER_VERTICAL, 5 ) 80 | 81 | 82 | bSizer3.Add( bSizer1, 0, wx.ALIGN_RIGHT|wx.EXPAND, 5 ) 83 | 84 | 85 | self.SetSizer( bSizer3 ) 86 | self.Layout() 87 | 88 | self.Centre( wx.BOTH ) 89 | 90 | def __del__( self ): 91 | pass 92 | 93 | 94 | -------------------------------------------------------------------------------- /CircularZone/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import pprint 3 | import traceback 4 | import sys 5 | 6 | print("Starting plugin CircularZone") 7 | try: 8 | from .CircularZone import * 9 | CircularZone().register() 10 | except Exception as e: 11 | traceback.print_exc(file=sys.stdout) 12 | pprint.pprint(e) 13 | -------------------------------------------------------------------------------- /CircularZone/round_keepout_area.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/CircularZone/round_keepout_area.png -------------------------------------------------------------------------------- /CircularZone/round_keepout_area.svg: -------------------------------------------------------------------------------- 1 | 2 | 16 | 18 | 19 | 21 | image/svg+xml 22 | 24 | 25 | 26 | 27 | 28 | 54 | 65 | 66 | 68 | 80 | 83 | 90 | 91 | 96 | 101 | 106 | 111 | 116 | 121 | 126 | 131 | 136 | 141 | 146 | 151 | 157 | 163 | 168 | 174 | 180 | 186 | 192 | 198 | 204 | 210 | 216 | 217 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Some KiCad plugins in Python 2 | 3 | Thoses plugins must be copied inside KiCad's python plugins 4 | directory (~/.kicad_plugins or /usr/share/kicad/scripting/plugins/ for 5 | Linux). 6 | Most of them use python plugin (Action plugins) in KiCad. This feature 7 | is enabled in daily builds of KiCad. 8 | See https://forum.kicad.info/t/howto-register-a-python-plugin-inside-pcbnew-tools-menu/5540 9 | 10 | 11 | ## ViaStitching 12 | 13 | A pure python via stitching. 14 | 15 | After select "Via Stitching" in Tools menu, choose your options in the 16 | interface. 17 | 18 | ![The interface](images/via1.png) 19 | 20 | Then the result should be: 21 | 22 | ![The result](images/via2.png) 23 | 24 | ## CircularZone 25 | 26 | A pure python script to create circular zone. 27 | 28 | Select a component. This composent will be used as center of the 29 | circular zone. If no component is selected, the origin (0,0) will be 30 | used as center. 31 | 32 | After select "Create a circular zone" in the Tools menu, choose the 33 | radius and the type of zone (normal or keep out). 34 | 35 | ![The interface](images/circular1.png) 36 | 37 | A circular zone will be created. Select it to change properties: 38 | 39 | ![Select zone](images/circular2.png) 40 | 41 | ![Open properties](images/circular3.png) 42 | 43 | Refill the area (B hotkey) then the circular zone is ready. 44 | 45 | ![Final result](images/circular4.png) 46 | -------------------------------------------------------------------------------- /ViaStitching/FillArea.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # FillArea.py 5 | # 6 | # Copyright 2017 JS Reynaud 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 2 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with this program; if not, write to the Free Software 20 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 21 | # MA 02110-1301, USA. 22 | 23 | from __future__ import print_function 24 | from pcbnew import * 25 | import sys 26 | import tempfile 27 | import shutil 28 | import os 29 | import random 30 | import pprint 31 | import wx 32 | 33 | 34 | def wxPrint(msg): 35 | wx.LogMessage(msg) 36 | 37 | 38 | # 39 | if sys.version[0] == '2': # maui 40 | xrange 41 | else: 42 | xrange = range 43 | 44 | 45 | """ 46 | # This script fills all areas of a specific net with Vias (Via Stitching) 47 | # 48 | # 49 | # Usage in pcbnew's python console: 50 | # First you neet to copy this file (named FillArea.py) in your kicad_plugins 51 | # directory (~/.kicad_plugins/ on Linux) 52 | # Launch pcbnew and open python console (last entry of Tools menu) 53 | # Then enter the following line (one by one, Hit enter after each) 54 | import FillArea 55 | FillArea.FillArea().Run() 56 | 57 | 58 | # Other example: 59 | # You can add modifications to parameters by adding functions calls: 60 | FillArea.FillArea().SetDebug().SetNetname("GND").SetStepMM(1.27).SetSizeMM(0.6).SetDrillMM(0.3).SetClearanceMM(0.2).Run() 61 | 62 | # with 63 | # SetDebug: Activate debug mode (print evolution of the board in ascii art) 64 | # SetNetname: Change the netname to consider for the filling 65 | # (default is /GND or fallback to GND) 66 | # SetStepMM: Change step between Via (in mm) 67 | # SetSizeMM: Change Via copper size (in mm) 68 | # SetDrillMM: Change Via drill hole size (in mm) 69 | # SetClearanceMM: Change clearance for Via (in mm) 70 | 71 | # You can also use it in command line. In this case, the first parameter is 72 | # the pcb file path. Default options are applied. 73 | 74 | """ 75 | 76 | 77 | class ViaObject: 78 | 79 | """ 80 | ViaObject holds all information of a single Via 81 | """ 82 | 83 | def __init__(self, x, y, pos_x, pos_y): 84 | self.X = x 85 | self.Y = y 86 | self.PosX = pos_x 87 | self.PosY = pos_y 88 | 89 | 90 | class FillArea: 91 | 92 | """ 93 | Automaticaly add via on area where there are no track/existing via, 94 | pads and keepout areas 95 | """ 96 | 97 | REASON_OK = 0 98 | REASON_NO_SIGNAL = 1 99 | REASON_OTHER_SIGNAL = 2 100 | REASON_KEEPOUT = 3 101 | REASON_TRACK = 4 102 | REASON_PAD = 5 103 | REASON_DRAWING = 6 104 | REASON_STEP = 7 105 | 106 | def __init__(self, filename=None): 107 | self.filename = None 108 | self.clearance = 0 109 | # Net name to use 110 | self.SetPCB(GetBoard()) 111 | # Set the filename 112 | self.SetFile(filename) 113 | # Step between via 114 | self.SetStepMM(2.54) 115 | # Size of the via (diameter of copper) 116 | self.SetSizeMM(0.46) 117 | # Size of the drill (diameter) 118 | self.SetDrillMM(0.20) 119 | # Isolation between via and other elements 120 | # ie: radius from the border of the via 121 | self.SetClearanceMM(0.2) 122 | self.only_selected_area = False 123 | self.delete_vias = False 124 | if self.pcb is not None: 125 | for lnet in ["GND", "/GND"]: 126 | if self.pcb.FindNet(lnet) is not None: 127 | self.SetNetname(lnet) 128 | break 129 | self.netname = None 130 | self.debug = False 131 | self.random = False 132 | self.star = False 133 | if self.netname is None: 134 | self.SetNetname("GND") 135 | 136 | self.tmp_dir = None 137 | 138 | def SetFile(self, filename): 139 | self.filename = filename 140 | if self.filename: 141 | self.SetPCB(LoadBoard(self.filename)) 142 | 143 | def SetDebug(self): 144 | wxPrint("Set debug") 145 | self.debug = True 146 | return self 147 | 148 | def SetRandom(self, r): 149 | random.seed() 150 | self.random = r 151 | return self 152 | 153 | def SetStar(self): 154 | self.star = True 155 | return self 156 | 157 | def SetPCB(self, pcb): 158 | self.pcb = pcb 159 | if self.pcb is not None: 160 | self.pcb.BuildListOfNets() 161 | return self 162 | 163 | def SetNetname(self, netname): 164 | self.netname = netname # .upper() 165 | # wx.LogMessage(self.netname) 166 | return self 167 | 168 | def SetStepMM(self, s): 169 | self.step = float(FromMM(s)) 170 | return self 171 | 172 | def SetSizeMM(self, s): 173 | self.size = float(FromMM(s)) 174 | return self 175 | 176 | def SetDrillMM(self, s): 177 | self.drill = float(FromMM(s)) 178 | return self 179 | 180 | def OnlyOnSelectedArea(self): 181 | self.only_selected_area = True 182 | return self 183 | 184 | def DeleteVias(self): 185 | self.delete_vias = True 186 | return self 187 | 188 | def SetClearanceMM(self, s): 189 | self.clearance = float(FromMM(s)) 190 | return self 191 | 192 | def GetReasonSymbol(self, reason): 193 | if isinstance(reason, ViaObject): 194 | return "X" 195 | if reason == self.REASON_NO_SIGNAL: 196 | return " " 197 | if reason == self.REASON_OTHER_SIGNAL: 198 | return "O" 199 | if reason == self.REASON_KEEPOUT: 200 | return "K" 201 | if reason == self.REASON_TRACK: 202 | return "T" 203 | if reason == self.REASON_PAD: 204 | return "P" 205 | if reason == self.REASON_DRAWING: 206 | return "D" 207 | if reason == self.REASON_STEP: 208 | return "-" 209 | 210 | return str(reason) 211 | 212 | def PrintRect(self, rectangle): 213 | """debuging tool 214 | Print board in ascii art 215 | """ 216 | print("_" * (len(rectangle)+2)) 217 | for y in range(len(rectangle[0])): 218 | print("|", end='') 219 | for x in range(len(rectangle)): 220 | print("%s" % self.GetReasonSymbol(rectangle[x][y]), end='') 221 | print("|") 222 | print("_" * (len(rectangle)+2)) 223 | print(''' 224 | OK = 'X' 225 | NO_SIGNAL = ' ' 226 | OTHER_SIGNAL = 'O' 227 | KEEPOUT = 'K' 228 | TRACK = 'T' 229 | PAD = 'P' 230 | DRAWING = 'D' 231 | STEP = '-' 232 | ''') 233 | 234 | def AddVia(self, position, x, y): 235 | m = VIA(self.pcb) 236 | m.SetPosition(position) 237 | m.SetNet(self.pcb.FindNet(self.netname)) 238 | m.SetViaType(VIA_THROUGH) 239 | m.SetDrill(int(self.drill)) 240 | m.SetWidth(int(self.size)) 241 | # again possible to mark via as own since no timestamp_t binding kicad v5.1.4 242 | m.SetTimeStamp(33) # USE 33 as timestamp to mark this via as generated by this script 243 | #wx.LogMessage('adding vias') 244 | self.pcb.Add(m) 245 | 246 | def RefillBoardAreas(self): 247 | for i in range(self.pcb.GetAreaCount()): 248 | area = self.pcb.GetArea(i) 249 | area.ClearFilledPolysList() 250 | area.UnFill() 251 | filler = ZONE_FILLER(self.pcb) 252 | filler.Fill(self.pcb.Zones()) 253 | 254 | def CheckViaInAllAreas(self, via, all_areas): 255 | ''' 256 | Checks if an existing Via collides with another area 257 | ''' 258 | # Enum all area 259 | for area in all_areas: 260 | area_layer = area.GetLayer() 261 | area_clearance = area.GetClearance() 262 | area_priority = area.GetPriority() 263 | is_keepout_area = area.GetIsKeepout() 264 | is_target_net = (area.GetNetname() == self.netname) # (area.GetNetname().upper() == self.netname) 265 | # wx.LogMessage(area.GetNetname()) #wx.LogMessage(area.GetNetname().upper()) 266 | 267 | if (not is_target_net): # Only process areas that are not in the target net 268 | # Offset is half the size of the via plus the clearance of the via or the area 269 | offset = max(self.clearance, area_clearance) + self.size / 2 270 | for dx in [-offset, offset]: 271 | # All 4 corners of the via are testet (upper, lower, left, right) but not the center 272 | for dy in [-offset, offset]: 273 | point_to_test = wxPoint(via.PosX + dx, via.PosY + dy) 274 | 275 | hit_test_area = area.HitTestFilledArea(point_to_test) # Collides with a filled area 276 | hit_test_edge = area.HitTestForEdge(point_to_test, 1) # Collides with an edge/corner 277 | try: 278 | hit_test_zone = area.HitTestInsideZone(point_to_test) # Is inside a zone (e.g. KeepOut) 279 | except: 280 | hit_test_zone = False 281 | wxPrint('exception: missing HitTestInsideZone: To Be Fixed') 282 | # hit_test_zone = area.HitTest(point_to_test) # Is inside a zone (e.g. KeepOut) kicad nightly 5.99 283 | if is_keepout_area and (hit_test_area or hit_test_edge or hit_test_zone): 284 | return self.REASON_KEEPOUT # Collides with keepout 285 | 286 | elif (hit_test_area or hit_test_edge): 287 | # Collides with another signal (e.g. on another layer) 288 | return self.REASON_OTHER_SIGNAL 289 | 290 | elif hit_test_zone: 291 | # Check if the zone is higher priority than other zones of the target net in the same point 292 | #target_areas_on_same_layer = filter(lambda x: ((x.GetPriority() > area_priority) and (x.GetLayer() == area_layer) and (x.GetNetname().upper() == self.netname)), all_areas) 293 | target_areas_on_same_layer = filter(lambda x: ((x.GetPriority() > area_priority) and ( 294 | x.GetLayer() == area_layer) and (x.GetNetname() == self.netname)), all_areas) 295 | for area_with_higher_priority in target_areas_on_same_layer: 296 | if area_with_higher_priority.HitTestInsideZone(point_to_test): 297 | break # Area of target net has higher priority on this layer 298 | else: 299 | # Collides with another signal (e.g. on another layer) 300 | return self.REASON_OTHER_SIGNAL 301 | 302 | return self.REASON_OK 303 | 304 | def ClearViaInStepSize(self, rectangle, x, y, distance): 305 | ''' 306 | Stepsize==0 307 | O O O O O O O O O 308 | O O O O O O O O O 309 | O O O O O O O O O 310 | O O O O O O O O O 311 | O O O O O O O O O 312 | O O O O O O O O O 313 | O O O O O O O O O 314 | 315 | Standard 316 | O O O O O 317 | 318 | O O O O O 319 | 320 | O O O O O 321 | 322 | O O O O O 323 | 324 | Star 325 | O O O O O 326 | O O O O 327 | O O O O O 328 | O O O O 329 | O O O O O 330 | O O O O 331 | O O O O O 332 | ''' 333 | for x_pos in range(x-distance, x+distance+1): 334 | if (x_pos >= 0) and (x_pos < len(rectangle)): 335 | distance_y = distance-abs(x-x_pos) if self.star else distance # Star or Standard shape 336 | for y_pos in range(y-distance_y, y+distance_y+1): 337 | if (y_pos >= 0) and (y_pos < len(rectangle[0])): 338 | if (x_pos == x) and (y_pos == y): 339 | continue 340 | rectangle[x_pos][y_pos] = self.REASON_STEP 341 | 342 | def Run(self): 343 | """ 344 | Launch the process 345 | """ 346 | target_tracks = self.pcb.GetTracks() 347 | 348 | if self.delete_vias: 349 | # timestmap again available 350 | #target_tracks = filter(lambda x: (x.GetNetname().upper() == self.netname), self.pcb.GetTracks()) 351 | target_tracks = filter(lambda x: (x.GetNetname() == self.netname), self.pcb.GetTracks()) 352 | target_tracks_cp = list(target_tracks) 353 | l = len (target_tracks_cp) 354 | for i in range(l): 355 | if target_tracks_cp[i].Type() == PCB_VIA_T: 356 | if target_tracks_cp[i].GetTimeStamp() == 33: 357 | self.pcb.RemoveNative(target_tracks_cp[i]) 358 | self.RefillBoardAreas() 359 | return # no need to run the rest of logic 360 | 361 | lboard = self.pcb.ComputeBoundingBox(False) 362 | origin = lboard.GetPosition() 363 | 364 | # Create an initial rectangle: all is set to "REASON_NO_SIGNAL" 365 | # get a margin to avoid out of range 366 | l_clearance = self.clearance + self.size 367 | x_limit = int((lboard.GetWidth() + l_clearance) / l_clearance) + 1 368 | y_limit = int((lboard.GetHeight() + l_clearance) / l_clearance) + 1 369 | 370 | rectangle = [[self.REASON_NO_SIGNAL]*y_limit for i in xrange(x_limit)] 371 | 372 | all_pads = self.pcb.GetPads() 373 | all_tracks = self.pcb.GetTracks() 374 | try: 375 | all_drawings = filter(lambda x: x.GetClass() == 'PTEXT' and self.pcb.GetLayerID( 376 | x.GetLayerName()) in (F_Cu, B_Cu), self.pcb.DrawingsList()) 377 | except: 378 | all_drawings = filter(lambda x: x.GetClass() == 'PTEXT' and self.pcb.GetLayerID( 379 | x.GetLayerName()) in (F_Cu, B_Cu), self.pcb.Drawings()) 380 | #wxPrint("exception on missing BOARD.DrawingsList") 381 | all_areas = [self.pcb.GetArea(i) for i in xrange(self.pcb.GetAreaCount())] 382 | # target_areas = filter(lambda x: (x.GetNetname().upper() == self.netname), all_areas) # KeepOuts are filtered because they have no name 383 | # KeepOuts are filtered because they have no name 384 | target_areas = filter(lambda x: (x.GetNetname() == self.netname), all_areas) 385 | 386 | via_list = [] # Create a list of existing vias => faster than scanning through the whole rectangle 387 | max_target_area_clearance = 0 388 | 389 | # Enum all target areas (Search possible positions for vias on the target net) 390 | for area in target_areas: 391 | wxPrint("Processing Target Area: %s, LayerName: %s..." % (area.GetNetname(), area.GetLayerName())) 392 | 393 | is_selected_area = area.IsSelected() 394 | area_clearance = area.GetClearance() 395 | if max_target_area_clearance < area_clearance: 396 | max_target_area_clearance = area_clearance 397 | 398 | if (not self.only_selected_area) or (self.only_selected_area and is_selected_area): # All areas or only the selected area 399 | # Check every possible point in the virtual coordinate system 400 | for x in xrange(len(rectangle)): 401 | for y in xrange(len(rectangle[0])): 402 | # No other "target area" found yet => go on with processing 403 | if rectangle[x][y] == self.REASON_NO_SIGNAL: 404 | current_x = origin.x + (x * l_clearance) # Center of the via 405 | current_y = origin.y + (y * l_clearance) 406 | 407 | test_result = True # Start with true, if a check fails, it is set to false 408 | 409 | # Offset is half the size of the via plus the clearance of the via or the area 410 | offset = max(self.clearance, area_clearance) + self.size / 2 411 | for dx in [-offset, offset]: 412 | # All 4 corners of the via are testet (upper, lower, left, right) but not the center 413 | for dy in [-offset, offset]: 414 | point_to_test = wxPoint(current_x + dx, current_y + dy) 415 | hit_test_area = area.HitTestFilledArea(point_to_test) # Collides with a filled area 416 | # Collides with an edge/corner 417 | hit_test_edge = area.HitTestForEdge(point_to_test, area_clearance) 418 | 419 | # test_result only remains true if the via is inside an area and not on an edge 420 | test_result &= (hit_test_area and not hit_test_edge) 421 | 422 | if test_result: 423 | # Create a via object with information about the via and place it in the rectangle 424 | via_obj = ViaObject(x=x, y=y, pos_x=current_x, pos_y=current_y) 425 | rectangle[x][y] = via_obj 426 | via_list.append(via_obj) 427 | 428 | if self.debug: 429 | wxPrint("\nPost target areas:") 430 | self.PrintRect(rectangle) 431 | 432 | # Enum all vias 433 | wxPrint("Processing all vias of target area...") 434 | for via in via_list: 435 | reason = self.CheckViaInAllAreas(via, all_areas) 436 | if reason != self.REASON_OK: 437 | rectangle[via.X][via.Y] = reason 438 | 439 | if self.debug: 440 | wxPrint("\nPost areas:") 441 | self.PrintRect(rectangle) 442 | 443 | # Same job with all pads => all pads on all layers 444 | wxPrint("Processing all pads...") 445 | for pad in all_pads: 446 | local_offset = max(pad.GetClearance(), self.clearance, max_target_area_clearance) + (self.size / 2) 447 | max_size = max(pad.GetSize().x, pad.GetSize().y) 448 | 449 | start_x = int(floor(((pad.GetPosition().x - (max_size / 2.0 + local_offset)) - origin.x) / l_clearance)) 450 | stop_x = int(ceil(((pad.GetPosition().x + (max_size / 2.0 + local_offset)) - origin.x) / l_clearance)) 451 | 452 | start_y = int(floor(((pad.GetPosition().y - (max_size / 2.0 + local_offset)) - origin.y) / l_clearance)) 453 | stop_y = int(ceil(((pad.GetPosition().y + (max_size / 2.0 + local_offset)) - origin.y) / l_clearance)) 454 | 455 | for x in range(start_x, stop_x + 1): 456 | for y in range(start_y, stop_y + 1): 457 | try: 458 | if isinstance(rectangle[x][y], ViaObject): 459 | start_rect = wxPoint(origin.x + (l_clearance * x) - local_offset, 460 | origin.y + (l_clearance * y) - local_offset) 461 | size_rect = wxSize(2 * local_offset, 2 * local_offset) 462 | if pad.HitTest(EDA_RECT(start_rect, size_rect), False): 463 | rectangle[x][y] = self.REASON_PAD 464 | except: 465 | wxPrint("exception on Processing all pads...") 466 | if self.debug: 467 | wxPrint("\nPost pads:") 468 | self.PrintRect(rectangle) 469 | 470 | # Same job with tracks => all tracks on all layers 471 | wxPrint("Processing all tracks...") 472 | for track in all_tracks: 473 | start_x = track.GetStart().x 474 | start_y = track.GetStart().y 475 | 476 | stop_x = track.GetEnd().x 477 | stop_y = track.GetEnd().y 478 | 479 | if start_x > stop_x: 480 | d = stop_x 481 | stop_x = start_x 482 | start_x = d 483 | 484 | if start_y > stop_y: 485 | d = stop_y 486 | stop_y = start_y 487 | start_y = d 488 | 489 | osx = start_x 490 | osy = start_y 491 | opx = stop_x 492 | opy = stop_y 493 | 494 | clearance = max(track.GetClearance(), self.clearance, max_target_area_clearance) + (self.size / 2) + (track.GetWidth() / 2) 495 | 496 | start_x = int(floor(((start_x - clearance) - origin.x) / l_clearance)) 497 | stop_x = int(ceil(((stop_x + clearance) - origin.x) / l_clearance)) 498 | 499 | start_y = int(floor(((start_y - clearance) - origin.y) / l_clearance)) 500 | stop_y = int(ceil(((stop_y + clearance) - origin.y) / l_clearance)) 501 | 502 | for x in range(start_x, stop_x + 1): 503 | for y in range(start_y, stop_y + 1): 504 | try: 505 | if isinstance(rectangle[x][y], ViaObject): 506 | start_rect = wxPoint(origin.x + (l_clearance * x) - clearance, 507 | origin.y + (l_clearance * y) - clearance) 508 | size_rect = wxSize(2 * clearance, 2 * clearance) 509 | if track.HitTest(EDA_RECT(start_rect, size_rect), False): 510 | rectangle[x][y] = self.REASON_TRACK 511 | except: 512 | wxPrint("exception on Processing all tracks...") 513 | 514 | if self.debug: 515 | wxPrint("\nPost tracks:") 516 | self.PrintRect(rectangle) 517 | 518 | # Same job with existing text 519 | wxPrint("Processing all existing drawings...") 520 | for draw in all_drawings: 521 | inter = float(self.clearance + self.size) 522 | bbox = draw.GetBoundingBox() 523 | 524 | start_x = int(floor(((bbox.GetPosition().x - inter) - origin.x) / l_clearance)) 525 | stop_x = int(ceil(((bbox.GetPosition().x + (bbox.GetSize().x + inter)) - origin.x) / l_clearance)) 526 | 527 | start_y = int(floor(((bbox.GetPosition().y - inter) - origin.y) / l_clearance)) 528 | stop_y = int(ceil(((bbox.GetPosition().y + (bbox.GetSize().y + inter)) - origin.y) / l_clearance)) 529 | 530 | for x in range(start_x, stop_x + 1): 531 | for y in range(start_y, stop_y + 1): 532 | rectangle[x][y] = self.REASON_DRAWING 533 | 534 | if self.debug: 535 | wxPrint("Post Drawnings:") 536 | self.PrintRect(rectangle) 537 | 538 | wxPrint("Remove vias to guarantee step size...") 539 | clear_distance = 0 540 | if self.step != 0.0: 541 | # How much "via steps" should be removed around a via (round up) 542 | clear_distance = int((self.step+l_clearance) / l_clearance) 543 | 544 | via_placed = 0 545 | for x in xrange(len(rectangle)): 546 | for y in xrange(len(rectangle[0])): 547 | if isinstance(rectangle[x][y], ViaObject): 548 | if clear_distance: 549 | self.ClearViaInStepSize(rectangle, x, y, clear_distance) 550 | 551 | via = rectangle[x][y] 552 | ran_x = 0 553 | ran_y = 0 554 | 555 | if self.random: 556 | ran_x = (random.random() * l_clearance / 2.0) - (l_clearance / 4.0) 557 | ran_y = (random.random() * l_clearance / 2.0) - (l_clearance / 4.0) 558 | 559 | self.AddVia(wxPoint(via.PosX + ran_x, via.PosY + ran_y), via.X, via.Y) 560 | via_placed += 1 561 | 562 | if self.debug: 563 | wxPrint("\nFinal result:") 564 | self.PrintRect(rectangle) 565 | 566 | self.RefillBoardAreas() 567 | 568 | if self.filename: 569 | self.pcb.Save(self.filename) 570 | msg = "{:d} vias placed\n".format(via_placed) 571 | wxPrint(msg+"Done!") 572 | 573 | 574 | if __name__ == '__main__': 575 | if len(sys.argv) < 2: 576 | print("Usage: %s " % sys.argv[0]) 577 | else: 578 | import sys 579 | FillArea(sys.argv[1]).SetDebug().Run() 580 | -------------------------------------------------------------------------------- /ViaStitching/FillAreaAction.py: -------------------------------------------------------------------------------- 1 | # 2 | # FillAreaAction.py 3 | # 4 | # Copyright 2017 JS Reynaud 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 2 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program; if not, write to the Free Software 18 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 19 | # MA 02110-1301, USA. 20 | from __future__ import print_function 21 | import pcbnew 22 | import wx 23 | from . import FillArea 24 | from . import FillAreaDialog 25 | import os 26 | 27 | 28 | def PopulateNets(anet, dlg): 29 | nets = pcbnew.GetBoard().GetNetsByName() 30 | for netname, net in nets.items(): 31 | netname = net.GetNetname() 32 | if netname != None and netname != "": 33 | dlg.m_cbNet.Append(netname) 34 | if anet != None: 35 | index = dlg.m_cbNet.FindString(anet) 36 | dlg.m_cbNet.Select(index) 37 | # 38 | 39 | 40 | class FillAreaDialogEx(FillAreaDialog.FillAreaDialog): 41 | 42 | def onDeleteClick(self, event): 43 | return self.EndModal(wx.ID_DELETE) 44 | 45 | 46 | class FillAreaAction(pcbnew.ActionPlugin): 47 | 48 | def defaults(self): 49 | self.name = "Via Stitching Generator" 50 | self.category = "Modify PCB" 51 | self.description = "Via Stitching for PCB Zone" 52 | self.icon_file_name = os.path.join(os.path.dirname(__file__), "./stitching-vias.png") 53 | self.show_toolbar_button = True 54 | 55 | def Run(self): 56 | a = FillAreaDialogEx(None) 57 | # a.m_SizeMM.SetValue("0.8") 58 | a.m_StepMM.SetValue("2.54") 59 | # a.m_DrillMM.SetValue("0.3") 60 | # a.m_Netname.SetValue("GND") 61 | # a.m_ClearanceMM.SetValue("0.2") 62 | a.m_Star.SetValue(True) 63 | a.m_bitmapStitching.SetBitmap(wx.Bitmap(os.path.join(os.path.dirname(os.path.realpath(__file__)), "stitching-vias-help.png"))) 64 | self.board = pcbnew.GetBoard() 65 | self.boardDesignSettings = self.board.GetDesignSettings() 66 | a.m_SizeMM.SetValue(str(pcbnew.ToMM(self.boardDesignSettings.GetCurrentViaSize()))) 67 | a.m_DrillMM.SetValue(str(pcbnew.ToMM(self.boardDesignSettings.GetCurrentViaDrill()))) 68 | a.m_ClearanceMM.SetValue(str(pcbnew.ToMM(self.boardDesignSettings.GetDefault().GetClearance()))) 69 | a.SetMinSize(a.GetSize()) 70 | 71 | PopulateNets("GND", a) 72 | modal_result = a.ShowModal() 73 | if modal_result == wx.ID_OK: 74 | wx.LogMessage('Via Stitching: Version 1.5') 75 | if 1: # try: 76 | fill = FillArea.FillArea() 77 | fill.SetStepMM(float(a.m_StepMM.GetValue().replace(',', '.'))) 78 | fill.SetSizeMM(float(a.m_SizeMM.GetValue().replace(',', '.'))) 79 | fill.SetDrillMM(float(a.m_DrillMM.GetValue().replace(',', '.'))) 80 | fill.SetClearanceMM(float(a.m_ClearanceMM.GetValue().replace(',', '.'))) 81 | # fill.SetNetname(a.m_Netname.GetValue()) 82 | netname = a.m_cbNet.GetStringSelection() 83 | fill.SetNetname(netname) 84 | if a.m_Debug.IsChecked(): 85 | fill.SetDebug() 86 | fill.SetRandom(a.m_Random.IsChecked()) 87 | if a.m_Star.IsChecked(): 88 | fill.SetStar() 89 | if a.m_only_selected.IsChecked(): 90 | fill.OnlyOnSelectedArea() 91 | fill.Run() 92 | else: # except Exception: 93 | wx.MessageDialog(None, "Invalid parameter") 94 | elif modal_result == wx.ID_DELETE: 95 | if 1: # try: 96 | fill = FillArea.FillArea() 97 | fill.SetNetname(a.m_cbNet.GetStringSelection()) # a.m_Netname.GetValue()) 98 | if a.m_Debug.IsChecked(): 99 | fill.SetDebug() 100 | fill.DeleteVias() 101 | fill.Run() 102 | else: # except Exception: 103 | wx.MessageDialog(None, "Invalid parameter for delete") 104 | else: 105 | print("Cancel") 106 | a.Destroy() 107 | 108 | 109 | FillAreaAction().register() 110 | -------------------------------------------------------------------------------- /ViaStitching/FillAreaDialog.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | ########################################################################### 4 | ## Python code generated with wxFormBuilder (version Oct 26 2018) 5 | ## http://www.wxformbuilder.org/ 6 | ## 7 | ## PLEASE DO *NOT* EDIT THIS FILE! 8 | ########################################################################### 9 | 10 | import wx 11 | import wx.xrc 12 | 13 | ########################################################################### 14 | ## Class FillAreaDialog 15 | ########################################################################### 16 | 17 | class FillAreaDialog ( wx.Dialog ): 18 | 19 | def __init__( self, parent ): 20 | wx.Dialog.__init__ ( self, parent, id = wx.ID_ANY, title = u"Fill Area parameters", pos = wx.DefaultPosition, size = wx.Size( 402,580 ), style = wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER ) 21 | 22 | import sys 23 | if sys.version_info[0] == 2: 24 | self.SetSizeHintsSz( wx.DefaultSize, wx.DefaultSize ) 25 | else: 26 | self.SetSizeHints( wx.DefaultSize, wx.DefaultSize ) 27 | 28 | bSizer3 = wx.BoxSizer( wx.VERTICAL ) 29 | 30 | fgSizer1 = wx.FlexGridSizer( 0, 2, 0, 0 ) 31 | fgSizer1.SetFlexibleDirection( wx.BOTH ) 32 | fgSizer1.SetNonFlexibleGrowMode( wx.FLEX_GROWMODE_SPECIFIED ) 33 | 34 | self.m_staticText3 = wx.StaticText( self, wx.ID_ANY, u"Via copper size (mm)", wx.DefaultPosition, wx.DefaultSize, 0 ) 35 | self.m_staticText3.Wrap( -1 ) 36 | 37 | fgSizer1.Add( self.m_staticText3, 1, wx.ALL|wx.EXPAND, 5 ) 38 | 39 | self.m_SizeMM = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 40 | self.m_SizeMM.SetMinSize( wx.Size( 1000,-1 ) ) 41 | 42 | fgSizer1.Add( self.m_SizeMM, 1, wx.ALL|wx.EXPAND, 5 ) 43 | 44 | self.m_staticText9 = wx.StaticText( self, wx.ID_ANY, u"Via drill size (mm)", wx.DefaultPosition, wx.DefaultSize, 0 ) 45 | self.m_staticText9.Wrap( -1 ) 46 | 47 | fgSizer1.Add( self.m_staticText9, 1, wx.ALL|wx.EXPAND, 5 ) 48 | 49 | self.m_DrillMM = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 50 | fgSizer1.Add( self.m_DrillMM, 1, wx.ALL|wx.EXPAND, 5 ) 51 | 52 | self.m_staticText5 = wx.StaticText( self, wx.ID_ANY, u"Via clearance (mm)", wx.DefaultPosition, wx.DefaultSize, 0 ) 53 | self.m_staticText5.Wrap( -1 ) 54 | 55 | fgSizer1.Add( self.m_staticText5, 1, wx.ALL|wx.EXPAND, 5 ) 56 | 57 | self.m_ClearanceMM = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 58 | fgSizer1.Add( self.m_ClearanceMM, 1, wx.ALL|wx.EXPAND, 5 ) 59 | 60 | self.m_staticText2 = wx.StaticText( self, wx.ID_ANY, u"Via grid (mm)", wx.DefaultPosition, wx.DefaultSize, 0 ) 61 | self.m_staticText2.Wrap( -1 ) 62 | 63 | fgSizer1.Add( self.m_staticText2, 0, wx.ALL, 5 ) 64 | 65 | self.m_StepMM = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 66 | fgSizer1.Add( self.m_StepMM, 1, wx.ALL|wx.EXPAND, 5 ) 67 | 68 | 69 | fgSizer1.Add( ( 0, 0), 1, wx.EXPAND, 5 ) 70 | 71 | self.m_bitmapStitching = wx.StaticBitmap( self, wx.ID_ANY, wx.NullBitmap, wx.DefaultPosition, wx.DefaultSize, 0 ) 72 | fgSizer1.Add( self.m_bitmapStitching, 0, wx.EXPAND, 5 ) 73 | 74 | self.m_staticText6 = wx.StaticText( self, wx.ID_ANY, u"Net name", wx.DefaultPosition, wx.DefaultSize, 0 ) 75 | self.m_staticText6.Wrap( -1 ) 76 | 77 | fgSizer1.Add( self.m_staticText6, 1, wx.ALL|wx.EXPAND, 5 ) 78 | 79 | m_cbNetChoices = [] 80 | self.m_cbNet = wx.ComboBox( self, wx.ID_ANY, u"GND", wx.DefaultPosition, wx.DefaultSize, m_cbNetChoices, wx.CB_READONLY ) 81 | fgSizer1.Add( self.m_cbNet, 1, wx.ALL|wx.EXPAND, 5 ) 82 | 83 | self.m_staticText7 = wx.StaticText( self, wx.ID_ANY, u"Debug mode", wx.DefaultPosition, wx.DefaultSize, 0 ) 84 | self.m_staticText7.Wrap( -1 ) 85 | 86 | fgSizer1.Add( self.m_staticText7, 1, wx.ALL|wx.EXPAND, 5 ) 87 | 88 | self.m_Debug = wx.CheckBox( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 89 | fgSizer1.Add( self.m_Debug, 1, wx.ALL|wx.EXPAND, 5 ) 90 | 91 | self.m_staticText8 = wx.StaticText( self, wx.ID_ANY, u"Random it", wx.DefaultPosition, wx.DefaultSize, 0 ) 92 | self.m_staticText8.Wrap( -1 ) 93 | 94 | fgSizer1.Add( self.m_staticText8, 0, wx.ALL, 5 ) 95 | 96 | self.m_Random = wx.CheckBox( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 97 | fgSizer1.Add( self.m_Random, 0, wx.ALL, 5 ) 98 | 99 | self.m_staticText42 = wx.StaticText( self, wx.ID_ANY, u"Star Pattern", wx.DefaultPosition, wx.DefaultSize, 0 ) 100 | self.m_staticText42.Wrap( -1 ) 101 | 102 | fgSizer1.Add( self.m_staticText42, 0, wx.ALL, 5 ) 103 | 104 | self.m_Star = wx.CheckBox( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 105 | fgSizer1.Add( self.m_Star, 0, wx.ALL, 5 ) 106 | 107 | self.m_staticText81 = wx.StaticText( self, wx.ID_ANY, u"Only under selected Zone", wx.DefaultPosition, wx.DefaultSize, 0 ) 108 | self.m_staticText81.Wrap( -1 ) 109 | 110 | fgSizer1.Add( self.m_staticText81, 0, wx.ALL, 5 ) 111 | 112 | self.m_only_selected = wx.CheckBox( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 113 | fgSizer1.Add( self.m_only_selected, 0, wx.ALL, 5 ) 114 | 115 | 116 | bSizer3.Add( fgSizer1, 1, wx.EXPAND, 5 ) 117 | 118 | bSizer1 = wx.BoxSizer( wx.HORIZONTAL ) 119 | 120 | self.m_staticText101 = wx.StaticText( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) 121 | self.m_staticText101.Wrap( -1 ) 122 | 123 | bSizer1.Add( self.m_staticText101, 1, wx.ALL, 5 ) 124 | 125 | self.m_button1 = wx.Button( self, wx.ID_OK, u"Run", wx.DefaultPosition, wx.DefaultSize, 0 ) 126 | 127 | self.m_button1.SetDefault() 128 | bSizer1.Add( self.m_button1, 0, wx.ALL|wx.ALIGN_CENTER_VERTICAL, 5 ) 129 | 130 | self.m_button2 = wx.Button( self, wx.ID_CANCEL, u"Cancel", wx.DefaultPosition, wx.DefaultSize, 0 ) 131 | bSizer1.Add( self.m_button2, 0, wx.ALL, 5 ) 132 | 133 | self.m_button3_delete = wx.Button( self, wx.ID_DELETE, u"Delete Vias", wx.DefaultPosition, wx.DefaultSize, 0 ) 134 | bSizer1.Add( self.m_button3_delete, 0, wx.ALL, 5 ) 135 | 136 | 137 | bSizer3.Add( bSizer1, 0, wx.EXPAND|wx.ALIGN_RIGHT, 5 ) 138 | 139 | 140 | self.SetSizer( bSizer3 ) 141 | self.Layout() 142 | 143 | self.Centre( wx.BOTH ) 144 | 145 | # Connect Events 146 | self.m_button3_delete.Bind( wx.EVT_BUTTON, self.onDeleteClick ) 147 | 148 | def __del__( self ): 149 | pass 150 | 151 | 152 | # Virtual event handlers, overide them in your derived class 153 | def onDeleteClick( self, event ): 154 | event.Skip() 155 | 156 | 157 | -------------------------------------------------------------------------------- /ViaStitching/__init__.py: -------------------------------------------------------------------------------- 1 | # Two way of installation of this plugin: 2 | # - Copy or link this directory to KiCad plugin directory (~/.kicad_plugin/ViaStitching/) 3 | # - Copy files to ~/.kicad_plugin except __init__.py... 4 | from __future__ import print_function 5 | import pprint 6 | import traceback 7 | import sys 8 | 9 | print("Starting plugin ViaStitching") 10 | try: 11 | from .FillAreaAction import * 12 | except Exception as e: 13 | traceback.print_exc(file=sys.stdout) 14 | pprint.pprint(e) 15 | -------------------------------------------------------------------------------- /ViaStitching/stitching-vias-help.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/ViaStitching/stitching-vias-help.png -------------------------------------------------------------------------------- /ViaStitching/stitching-vias-help.svg: -------------------------------------------------------------------------------- 1 | 2 | 20 | 22 | 23 | 25 | image/svg+xml 26 | 28 | 29 | 30 | 31 | 32 | 60 | 71 | 72 | 74 | 81 | 84 | 85 | 92 | 95 | 96 | 97 | 105 | 108 | 111 | 121 | 127 | 134 | 135 | 145 | 148 | 156 | 164 | 165 | 168 | 176 | 184 | 185 | 188 | 196 | 204 | 205 | 206 | 209 | 215 | 221 | 227 | 233 | 239 | 240 | d 251 | 252 | 253 | -------------------------------------------------------------------------------- /ViaStitching/stitching-vias.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/ViaStitching/stitching-vias.png -------------------------------------------------------------------------------- /ViaStitching/stitching-vias.svg: -------------------------------------------------------------------------------- 1 | 2 | 20 | 22 | 23 | 25 | image/svg+xml 26 | 28 | 29 | 30 | 31 | 32 | 56 | 67 | 68 | 70 | 77 | 80 | 81 | 88 | 91 | 92 | 93 | 103 | 109 | 116 | 117 | 127 | 130 | 138 | 146 | 154 | 155 | 156 | -------------------------------------------------------------------------------- /images/circular1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/images/circular1.png -------------------------------------------------------------------------------- /images/circular2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/images/circular2.png -------------------------------------------------------------------------------- /images/circular3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/images/circular3.png -------------------------------------------------------------------------------- /images/circular4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/images/circular4.png -------------------------------------------------------------------------------- /images/via1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/images/via1.png -------------------------------------------------------------------------------- /images/via2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/easyw/kicad-action-scripts/da2a1335e2d6bc7e8560431865d2a56f9d220aae/images/via2.png --------------------------------------------------------------------------------