KiCad PCB EDA Suite
Loading...
Searching...
No Matches
gerber_jobfile_writer.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean_Pierre Charras <jp.charras at wanadoo.fr>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
30#include <fstream>
31#include <iomanip>
32#include <vector>
33
34#include <build_version.h>
35#include <locale_io.h>
36#include <pcb_edit_frame.h>
37#include <plotters/plotter.h>
38
39#include <board.h>
41#include <footprint.h>
42#include <pad.h>
43#include <pcb_track.h>
44#include <zone.h>
45
47#include <gbr_metadata.h>
49#include <pcbplot.h>
50#include <reporter.h>
52
53
55{
56 m_pcb = aPcb;
57 m_reporter = aReporter;
58 m_conversionUnits = 1.0 / pcbIUScale.IU_PER_MM; // Gerber units = mm
59}
60
61std::string GERBER_JOBFILE_WRITER::formatStringFromUTF32( const wxString& aText )
62{
63 std::string fmt_text; // the text after UTF32 to UTF8 conversion
64 fmt_text = aText.utf8_string();
65
66 return fmt_text;
67}
68
69
71{
72 int flag = SIDE_NONE;
73
74 for( PCB_LAYER_ID layer : m_params.m_LayerId )
75 {
76 if( layer == B_SilkS )
78
79 if( layer == F_SilkS )
80 flag |= SIDE_TOP;
81 }
82
83 return (enum ONSIDE) flag;
84}
85
86
88{
89 int flag = SIDE_NONE;
90
91 for( PCB_LAYER_ID layer : m_params.m_LayerId )
92 {
93 if( layer == B_Mask )
95
96 if( layer == F_Mask )
97 flag |= SIDE_TOP;
98 }
99
100 return (enum ONSIDE) flag;
101}
102
104{
105 // return the key associated to sides used for some layers
106 // "No, TopOnly, BotOnly or Both"
107 const char* value = nullptr;
108
109 switch( aValue )
110 {
111 case SIDE_NONE: value = "No"; break;
112 case SIDE_TOP: value = "TopOnly"; break;
113 case SIDE_BOTTOM: value = "BotOnly"; break;
114 case SIDE_BOTH: value = "Both"; break;
115 }
116
117 return value;
118}
119
120
121bool GERBER_JOBFILE_WRITER::CreateJobFile( const wxString& aFullFilename )
122{
123 bool success;
124 wxString msg;
125
126 success = WriteJSONJobFile( aFullFilename );
127
128 if( !success )
129 {
130 if( m_reporter )
131 {
132 msg.Printf( _( "Failed to create file '%s'." ), aFullFilename );
134 }
135 }
136 else if( m_reporter )
137 {
138 msg.Printf( _( "Created Gerber job file '%s'." ), aFullFilename );
140 }
141
142 return success;
143}
144
145
147{
148 m_json["Header"] = {
149 {
150 "GenerationSoftware",
151 {
152 { "Vendor", "KiCad" },
153 { "Application", "Pcbnew" },
154 { "Version", GetBuildVersion() }
155 }
156 },
157 {
158 // The attribute value must conform to the full version of the ISO 8601
159 // date and time format, including time and time zone.
161 }
162 };
163}
164
165
166bool GERBER_JOBFILE_WRITER::WriteJSONJobFile( const wxString& aFullFilename )
167{
168 // Note: in Gerber job file, dimensions are in mm, and are floating numbers
169 std::ofstream file( aFullFilename.ToUTF8() );
170
172
173 m_json = nlohmann::ordered_json( {} );
174
175 // output the job file header
177
178 // Add the General Specs
180
181 // Job file support a few design rules:
183
184 // output the gerber file list:
186
187 // output the board stackup:
189
190 file << std::setw( 2 ) << m_json << std::endl;
191
192 return true;
193}
194
195
196double GERBER_JOBFILE_WRITER::mapValue( double aUiValue )
197{
198 // A helper function to convert aUiValue in Json units (mm) and to have
199 // 4 digits in Json in mantissa when using %g to print it
200 // i.e. displays values truncated in 0.1 microns.
201 // This is enough for a Json file
202 char buffer[128];
203 std::snprintf( buffer, sizeof( buffer ), "%.4f", aUiValue * m_conversionUnits );
204
205 long double output;
206 sscanf( buffer, "%Lg", &output );
207
208 return output;
209
210}
211
212
214{
215 m_json["GeneralSpecs"] = nlohmann::ordered_json( {} );
216 m_json["GeneralSpecs"]["ProjectId"] = nlohmann::ordered_json( {} );
217
218 // Creates the ProjectId. Format is (from Gerber file format doc):
219 // ProjectId,<project id>,<project GUID>,<revision id>*%
220 // <project id> is the name of the project, restricted to basic ASCII symbols only,
221 // and comma not accepted
222 // All illegal chars will be replaced by underscore
223 // Rem: <project id> accepts only ASCII 7 code (only basic ASCII codes are allowed in gerber files).
224 //
225 // <project GUID> is a string which is an unique id of a project.
226 // However Kicad does not handle such a project GUID, so it is built from the board name
227 wxFileName fn = m_pcb->GetFileName();
228 wxString msg = fn.GetFullName();
229
230 // Build a <project GUID>, from the board name
231 wxString guid = GbrMakeProjectGUIDfromString( msg );
232
233 // build the <project id> string: this is the board short filename (without ext)
234 // and in UTF8 format.
235 msg = fn.GetName();
236
237 // build the <rev> string. All non ASCII chars are in UTF8 form
239
240 if( rev.IsEmpty() )
241 rev = wxT( "rev?" );
242
243 m_json["GeneralSpecs"]["ProjectId"]["Name"] = msg.utf8_string().c_str();
244 m_json["GeneralSpecs"]["ProjectId"]["GUID"] = guid;
245 m_json["GeneralSpecs"]["ProjectId"]["Revision"] = rev.utf8_string().c_str();
246
247 // output the board size in mm:
249
250 m_json["GeneralSpecs"]["Size"]["X"] = mapValue( brect.GetWidth() );
251 m_json["GeneralSpecs"]["Size"]["Y"] = mapValue( brect.GetHeight() );
252
253
254 // Add some data to the JSON header, GeneralSpecs:
255 // number of copper layers
256 m_json["GeneralSpecs"]["LayerNumber"] = m_pcb->GetCopperLayerCount();
257
258 // Board thickness
259 m_json["GeneralSpecs"]["BoardThickness"] =
261
262 // Copper finish
264
265 if( !brd_stackup.m_FinishType.IsEmpty() )
266 m_json["GeneralSpecs"]["Finish"] = brd_stackup.m_FinishType;
267
268 if( brd_stackup.m_HasDielectricConstrains )
269 m_json["GeneralSpecs"]["ImpedanceControlled"] = true;
270
271 if( brd_stackup.m_CastellatedPads )
272 m_json["GeneralSpecs"]["Castellated"] = true;
273
274 if( brd_stackup.m_EdgePlating )
275 m_json["GeneralSpecs"]["EdgePlating"] = true;
276
277 if( brd_stackup.m_EdgeConnectorConstraints )
278 {
279 m_json["GeneralSpecs"]["EdgeConnector"] = true;
280
281 m_json["GeneralSpecs"]["EdgeConnectorBevelled"] =
283 }
284
285#if 0 // Not yet in use
286 /* The board type according to IPC-2221. There are six primary board types:
287 - Type 1 - Single-sided
288 - Type 2 - Double-sided
289 - Type 3 - Multilayer, TH components only
290 - Type 4 - Multilayer, with TH, blind and/or buried vias.
291 - Type 5 - Multilayer metal-core board, TH components only
292 - Type 6 - Multilayer metal-core
293 */
294 m_json["GeneralSpecs"]["IPC-2221-Type"] = 4;
295
296 /* Via protection: key words:
297 Ia Tented - Single-sided
298 Ib Tented - Double-sided
299 IIa Tented and Covered - Single-sided
300 IIb Tented and Covered - Double-sided
301 IIIa Plugged - Single-sided
302 IIIb Plugged - Double-sided
303 IVa Plugged and Covered - Single-sided
304 IVb Plugged and Covered - Double-sided
305 V Filled (fully plugged)
306 VI Filled and Covered
307 VIII Filled and Capped
308 None...No protection
309 */
310 m_json["GeneralSpecs"]["ViaProtection"] = "Ib";
311#endif
312}
313
314
316{
317 // Add the Files Attributes section in JSON format to m_JSONbuffer
318 m_json["FilesAttributes"] = nlohmann::ordered_json::array();
319
320 for( unsigned ii = 0; ii < m_params.m_GerberFileList.GetCount(); ii++ )
321 {
322 wxString& name = m_params.m_GerberFileList[ii];
323 PCB_LAYER_ID layer = m_params.m_LayerId[ii];
324 wxString gbr_layer_id;
325 bool skip_file = false; // true to skip files which should not be in job file
326 const char* polarity = "Positive";
327
328 nlohmann::ordered_json file_json;
329
330 if( IsCopperLayer( layer ) )
331 {
332 gbr_layer_id = wxT( "Copper,L" );
333
334 if( layer == B_Cu )
335 gbr_layer_id << m_pcb->GetCopperLayerCount();
336 else
337 gbr_layer_id << layer + 1;
338
339 gbr_layer_id << wxT( "," );
340
341 if( layer == B_Cu )
342 gbr_layer_id << wxT( "Bot" );
343 else if( layer == F_Cu )
344 gbr_layer_id << wxT( "Top" );
345 else
346 gbr_layer_id << wxT( "Inr" );
347 }
348
349 else
350 {
351 switch( layer )
352 {
353 case B_Adhes:
354 gbr_layer_id = wxT( "Glue,Bot" );
355 break;
356 case F_Adhes:
357 gbr_layer_id = wxT( "Glue,Top" );
358 break;
359
360 case B_Paste:
361 gbr_layer_id = wxT( "SolderPaste,Bot" );
362 break;
363 case F_Paste:
364 gbr_layer_id = wxT( "SolderPaste,Top" );
365 break;
366
367 case B_SilkS:
368 gbr_layer_id = wxT( "Legend,Bot" );
369 break;
370 case F_SilkS:
371 gbr_layer_id = wxT( "Legend,Top" );
372 break;
373
374 case B_Mask:
375 gbr_layer_id = wxT( "SolderMask,Bot" );
376 polarity = "Negative";
377 break;
378 case F_Mask:
379 gbr_layer_id = wxT( "SolderMask,Top" );
380 polarity = "Negative";
381 break;
382
383 case Edge_Cuts:
384 gbr_layer_id = wxT( "Profile" );
385 break;
386
387 case B_Fab:
388 gbr_layer_id = wxT( "AssemblyDrawing,Bot" );
389 break;
390 case F_Fab:
391 gbr_layer_id = wxT( "AssemblyDrawing,Top" );
392 break;
393
394 case Margin:
395 case B_CrtYd:
396 case F_CrtYd:
397 skip_file = true;
398 break;
399
400 case Dwgs_User:
401 case Cmts_User:
402 case Eco1_User:
403 case Eco2_User:
404 case User_1:
405 case User_2:
406 case User_3:
407 case User_4:
408 case User_5:
409 case User_6:
410 case User_7:
411 case User_8:
412 case User_9:
413 gbr_layer_id = wxT( "Other,User" );
414 break;
415
416 default:
417 skip_file = true;
418
419 if( m_reporter )
420 m_reporter->Report( wxT( "Unexpected layer id in job file" ), RPT_SEVERITY_ERROR );
421
422 break;
423 }
424 }
425
426 if( !skip_file )
427 {
428 // name can contain non ASCII7 chars.
429 // Ensure the name is JSON compatible.
430 std::string strname = formatStringFromUTF32( name );
431
432 file_json["Path"] = strname.c_str();
433 file_json["FileFunction"] = gbr_layer_id;
434 file_json["FilePolarity"] = polarity;
435
436 m_json["FilesAttributes"] += file_json;
437 }
438 }
439}
440
441
443{
444 // Add the Design Rules section in JSON format to m_JSONbuffer
445 // Job file support a few design rules:
446 std::shared_ptr<NET_SETTINGS>& netSettings = m_pcb->GetDesignSettings().m_NetSettings;
447
448 int minclearanceOuter = netSettings->GetDefaultNetclass()->GetClearance();
449 bool hasInnerLayers = m_pcb->GetCopperLayerCount() > 2;
450
451 // Search a smaller clearance in other net classes, if any.
452 for( const auto& [name, netclass] : netSettings->GetNetclasses() )
453 minclearanceOuter = std::min( minclearanceOuter, netclass->GetClearance() );
454
455 // job file knows different clearance types.
456 // Kicad knows only one clearance for pads and tracks
457 int minclearance_track2track = minclearanceOuter;
458
459 // However, pads can have a specific clearance defined for a pad or a footprint,
460 // and min clearance can be dependent on layers.
461 // Search for a minimal pad clearance:
462 int minPadClearanceOuter = netSettings->GetDefaultNetclass()->GetClearance();
463 int minPadClearanceInner = netSettings->GetDefaultNetclass()->GetClearance();
464
465 for( FOOTPRINT* footprint : m_pcb->Footprints() )
466 {
467 for( PAD* pad : footprint->Pads() )
468 {
469 for( PCB_LAYER_ID layer : pad->GetLayerSet().Seq() )
470 {
471 int padClearance = pad->GetOwnClearance( layer );
472
473 if( layer == B_Cu || layer == F_Cu )
474 minPadClearanceOuter = std::min( minPadClearanceOuter, padClearance );
475 else
476 minPadClearanceInner = std::min( minPadClearanceInner, padClearance );
477 }
478 }
479 }
480
481 m_json["DesignRules"] = { {
482 { "Layers", "Outer" },
483 { "PadToPad", mapValue( minPadClearanceOuter ) },
484 { "PadToTrack", mapValue( minPadClearanceOuter ) },
485 { "TrackToTrack", mapValue( minclearance_track2track ) }
486 } };
487
488 // Until this is changed in Kicad, use the same value for internal tracks
489 int minclearanceInner = minclearanceOuter;
490
491 // Output the minimal track width
492 int mintrackWidthOuter = INT_MAX;
493 int mintrackWidthInner = INT_MAX;
494
495 for( PCB_TRACK* track : m_pcb->Tracks() )
496 {
497 if( track->Type() == PCB_VIA_T )
498 continue;
499
500 if( track->GetLayer() == B_Cu || track->GetLayer() == F_Cu )
501 mintrackWidthOuter = std::min( mintrackWidthOuter, track->GetWidth() );
502 else
503 mintrackWidthInner = std::min( mintrackWidthInner, track->GetWidth() );
504 }
505
506 if( mintrackWidthOuter != INT_MAX )
507 m_json["DesignRules"][0]["MinLineWidth"] = mapValue( mintrackWidthOuter );
508
509 // Output the minimal zone to xx clearance
510 // Note: zones can have a zone clearance set to 0
511 // if happens, the actual zone clearance is the clearance of its class
512 minclearanceOuter = INT_MAX;
513 minclearanceInner = INT_MAX;
514
515 for( ZONE* zone : m_pcb->Zones() )
516 {
517 if( zone->GetIsRuleArea() || !zone->IsOnCopperLayer() )
518 continue;
519
520 for( PCB_LAYER_ID layer : zone->GetLayerSet().Seq() )
521 {
522 int zclerance = zone->GetOwnClearance( layer );
523
524 if( layer == B_Cu || layer == F_Cu )
525 minclearanceOuter = std::min( minclearanceOuter, zclerance );
526 else
527 minclearanceInner = std::min( minclearanceInner, zclerance );
528 }
529 }
530
531 if( minclearanceOuter != INT_MAX )
532 m_json["DesignRules"][0]["TrackToRegion"] = mapValue( minclearanceOuter );
533
534 if( minclearanceOuter != INT_MAX )
535 m_json["DesignRules"][0]["RegionToRegion"] = mapValue( minclearanceOuter );
536
537 if( hasInnerLayers )
538 {
539 m_json["DesignRules"] += nlohmann::ordered_json( {
540 { "Layers", "Inner" },
541 { "PadToPad", mapValue( minPadClearanceInner ) },
542 { "PadToTrack", mapValue( minPadClearanceInner ) },
543 { "TrackToTrack", mapValue( minclearance_track2track ) }
544 } );
545
546 if( mintrackWidthInner != INT_MAX )
547 m_json["DesignRules"][1]["MinLineWidth"] = mapValue( mintrackWidthInner );
548
549 if( minclearanceInner != INT_MAX )
550 m_json["DesignRules"][1]["TrackToRegion"] = mapValue( minclearanceInner );
551
552 if( minclearanceInner != INT_MAX )
553 m_json["DesignRules"][1]["RegionToRegion"] = mapValue( minclearanceInner );
554 }
555}
556
557
559{
560 // Add the Material Stackup section in JSON format to m_JSONbuffer
561 m_json["MaterialStackup"] = nlohmann::ordered_json::array();
562
563 // Build the candidates list:
564 LSET maskLayer;
566
567 // Ensure brd_stackup is up to date (i.e. no change made by SynchronizeWithBoard() )
568 bool uptodate = not brd_stackup.SynchronizeWithBoard( &m_pcb->GetDesignSettings() );
569
570 if( m_reporter && !uptodate && m_pcb->GetDesignSettings().m_HasStackup )
571 m_reporter->Report( _( "Board stackup settings not up to date." ), RPT_SEVERITY_ERROR );
572
573 PCB_LAYER_ID last_copper_layer = F_Cu;
574
575 // Generate the list (top to bottom):
576 for( int ii = 0; ii < brd_stackup.GetCount(); ++ii )
577 {
578 BOARD_STACKUP_ITEM* item = brd_stackup.GetStackupLayer( ii );
579
580 int sub_layer_count =
581 item->GetType() == BS_ITEM_TYPE_DIELECTRIC ? item->GetSublayersCount() : 1;
582
583 for( int sub_idx = 0; sub_idx < sub_layer_count; sub_idx++ )
584 {
585 // layer thickness is always in mm
586 double thickness = mapValue( item->GetThickness( sub_idx ) );
587 wxString layer_type;
588 std::string layer_name; // for comment
589
590 nlohmann::ordered_json layer_json;
591
592 switch( item->GetType() )
593 {
595 layer_type = wxT( "Copper" );
596 layer_name = formatStringFromUTF32( m_pcb->GetLayerName( item->GetBrdLayerId() ) );
597 last_copper_layer = item->GetBrdLayerId();
598 break;
599
601 layer_type = wxT( "Legend" );
602 layer_name = formatStringFromUTF32( item->GetTypeName() );
603 break;
604
606 layer_type = wxT( "SolderMask" );
607 layer_name = formatStringFromUTF32( item->GetTypeName() );
608 break;
609
611 layer_type = wxT( "SolderPaste" );
612 layer_name = formatStringFromUTF32( item->GetTypeName() );
613 break;
614
616 layer_type = wxT( "Dielectric" );
617 // The option core or prepreg is not added here, as it creates constraints
618 // in build process, not necessary wanted.
619 if( sub_layer_count > 1 )
620 {
621 layer_name =
622 formatStringFromUTF32( wxString::Format( wxT( "dielectric layer %d - %d/%d" ),
623 item->GetDielectricLayerId(), sub_idx + 1, sub_layer_count ) );
624 }
625 else
626 layer_name = formatStringFromUTF32( wxString::Format(
627 wxT( "dielectric layer %d" ), item->GetDielectricLayerId() ) );
628 break;
629
630 default:
631 break;
632 }
633
634 layer_json["Type"] = layer_type;
635
636 if( item->IsColorEditable() && uptodate )
637 {
638 if( IsPrmSpecified( item->GetColor( sub_idx ) ) )
639 {
640 wxString colorName = item->GetColor( sub_idx );
641
642 if( colorName.StartsWith( wxT( "#" ) ) ) // This is a user defined color,
643 // not in standard color list.
644 {
645 // In job file a color can be given by its RGB values (0...255)
646 // like R<number><G<number>B<number> notation
647 wxColor color( COLOR4D( colorName ).ToColour() );
648 colorName.Printf( wxT( "R%dG%dB%d" ),
649 color.Red(),
650 color.Green(),
651 color.Blue() );
652 }
653 else
654 {
655 const std::vector<FAB_LAYER_COLOR>& color_list =
656 GetStandardColors( item->GetType() );
657
658 // Colors for dielectric use a color list that is mainly not normalized in
659 // job file names. So if a color is in the dielectric standard color list
660 // it can be a standard name or not.
661 // Colors for solder mask and silk screen use a mainly normalized
662 // color list, but this list can also contain not normalized colors.
663 // If not normalized, use the R<number><G<number>B<number> notation
664 for( const FAB_LAYER_COLOR& prm_color : color_list )
665 {
666 if( colorName == prm_color.GetName() )
667 {
668 colorName = prm_color.GetColorAsString();
669 break;
670 }
671 }
672 }
673
674 layer_json["Color"] = colorName;
675 }
676 }
677
678 if( item->IsThicknessEditable() && uptodate )
679 layer_json["Thickness"] = thickness;
680
681 if( item->GetType() == BS_ITEM_TYPE_DIELECTRIC )
682 {
683 if( item->HasMaterialValue() )
684 {
685 layer_json["Material"] = item->GetMaterial( sub_idx );
686
687 // These constrains are only written if the board has impedance controlled tracks.
688 // If the board is not impedance controlled, they are useless.
689 // Do not add constrains that create more expensive boards.
690
691 if( brd_stackup.m_HasDielectricConstrains )
692 {
693 // Generate Epsilon R if > 1.0 (value <= 1.0 means not specified: it is not
694 // a possible value
695 if( item->GetEpsilonR() > 1.0 )
696 layer_json["DielectricConstant"] = item->FormatEpsilonR( sub_idx );
697
698 // Generate LossTangent > 0.0 (value <= 0.0 means not specified: it is not
699 // a possible value
700 if( item->GetLossTangent() > 0.0 )
701 layer_json["LossTangent"] = item->FormatLossTangent( sub_idx );
702 }
703 }
704
705 // Copper layers IDs use only even values like 0, 2, 4 ...
706 // and first layer = F_Cu = 0, last layer = B_Cu = 2
707 // inner layers Ids are 4, 6 , 8 ...
708 PCB_LAYER_ID next_copper_layer = ( PCB_LAYER_ID )( last_copper_layer + 2 );
709
710 if( last_copper_layer == F_Cu )
711 next_copper_layer = In1_Cu;
712
713 // If the next_copper_layer is the last copper layer, the next layer id is B_Cu
714 if( next_copper_layer/2 >= m_pcb->GetCopperLayerCount() )
715 next_copper_layer = B_Cu;
716
717 wxString subLayerName;
718
719 if( sub_layer_count > 1 )
720 subLayerName.Printf( wxT( " (%d/%d)" ), sub_idx + 1, sub_layer_count );
721
722 wxString name = wxString::Format( wxT( "%s/%s%s" ),
723 formatStringFromUTF32( m_pcb->GetLayerName( last_copper_layer ) ),
724 formatStringFromUTF32( m_pcb->GetLayerName( next_copper_layer ) ),
725 subLayerName );
726
727 layer_json["Name"] = name;
728
729 // Add a comment ("Notes"):
730 wxString note;
731
732 note << wxString::Format( wxT( "Type: %s" ), layer_name.c_str() );
733
734 note << wxString::Format( wxT( " (from %s to %s)" ),
735 formatStringFromUTF32( m_pcb->GetLayerName( last_copper_layer ) ),
736 formatStringFromUTF32( m_pcb->GetLayerName( next_copper_layer ) ) );
737
738 layer_json["Notes"] = note;
739 }
740 else if( item->GetType() == BS_ITEM_TYPE_SOLDERMASK
741 || item->GetType() == BS_ITEM_TYPE_SILKSCREEN )
742 {
743 if( item->HasMaterialValue() )
744 {
745 layer_json["Material"] = item->GetMaterial();
746
747 // These constrains are only written if the board has impedance controlled tracks.
748 // If the board is not impedance controlled, they are useless.
749 // Do not add constrains that create more expensive boards.
750 if( brd_stackup.m_HasDielectricConstrains )
751 {
752 // Generate Epsilon R if > 1.0 (value <= 1.0 means not specified: it is not
753 // a possible value
754 if( item->GetEpsilonR() > 1.0 )
755 layer_json["DielectricConstant"] = item->FormatEpsilonR();
756
757 // Generate LossTangent > 0.0 (value <= 0.0 means not specified: it is not
758 // a possible value
759 if( item->GetLossTangent() > 0.0 )
760 layer_json["LossTangent"] = item->FormatLossTangent();
761 }
762 }
763
764 layer_json["Name"] = layer_name.c_str();
765 }
766 else
767 {
768 layer_json["Name"] = layer_name.c_str();
769 }
770
771 m_json["MaterialStackup"].insert( m_json["MaterialStackup"].end(), layer_json );
772 }
773 }
774}
int color
Definition: DXF_plotter.cpp:60
const char * name
Definition: DXF_plotter.cpp:59
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
bool IsPrmSpecified(const wxString &aPrmValue)
@ BS_EDGE_CONNECTOR_BEVELLED
Definition: board_stackup.h:59
@ BS_ITEM_TYPE_COPPER
Definition: board_stackup.h:45
@ BS_ITEM_TYPE_SILKSCREEN
Definition: board_stackup.h:51
@ BS_ITEM_TYPE_DIELECTRIC
Definition: board_stackup.h:46
@ BS_ITEM_TYPE_SOLDERPASTE
Definition: board_stackup.h:48
@ BS_ITEM_TYPE_SOLDERMASK
Definition: board_stackup.h:49
wxString GetBuildVersion()
Get the full KiCad version string.
std::shared_ptr< NET_SETTINGS > m_NetSettings
int GetBoardThickness() const
The full thickness of the board including copper and masks.
BOARD_STACKUP & GetStackupDescriptor()
Manage one layer needed to make a physical board.
Definition: board_stackup.h:96
wxString GetTypeName() const
int GetSublayersCount() const
double GetEpsilonR(int aDielectricSubLayer=0) const
wxString GetColor(int aDielectricSubLayer=0) const
bool HasMaterialValue(int aDielectricSubLayer=0) const
PCB_LAYER_ID GetBrdLayerId() const
bool IsThicknessEditable() const
int GetThickness(int aDielectricSubLayer=0) const
BOARD_STACKUP_ITEM_TYPE GetType() const
wxString GetMaterial(int aDielectricSubLayer=0) const
wxString FormatEpsilonR(int aDielectricSubLayer=0) const
int GetDielectricLayerId() const
bool IsColorEditable() const
wxString FormatLossTangent(int aDielectricSubLayer=0) const
double GetLossTangent(int aDielectricSubLayer=0) const
Manage layers needed to make a physical board.
bool m_CastellatedPads
True if castellated pads exist.
int GetCount() const
bool SynchronizeWithBoard(BOARD_DESIGN_SETTINGS *aSettings)
Synchronize the BOARD_STACKUP_ITEM* list with the board.
bool m_HasDielectricConstrains
True if some layers have impedance controlled tracks or have specific constrains for micro-wave appli...
BOARD_STACKUP_ITEM * GetStackupLayer(int aIndex)
bool m_EdgePlating
True if the edge board is plated.
BS_EDGE_CONNECTOR_CONSTRAINTS m_EdgeConnectorConstraints
If the board has edge connector cards, some constrains can be specified in job file: BS_EDGE_CONNECTO...
wxString m_FinishType
The name of external copper finish.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:295
const BOX2I GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:937
const ZONES & Zones() const
Definition: board.h:340
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:703
int GetCopperLayerCount() const
Definition: board.cpp:780
const FOOTPRINTS & Footprints() const
Definition: board.h:336
const TRACKS & Tracks() const
Definition: board.h:334
const wxString & GetFileName() const
Definition: board.h:332
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:613
PROJECT * GetProject() const
Definition: board.h:499
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:934
constexpr size_type GetWidth() const
Definition: box2.h:214
constexpr size_type GetHeight() const
Definition: box2.h:215
void addJSONHeader()
Add the job file header in JSON format to m_JSONbuffer.
void addJSONMaterialStackup()
Add the Material Stackup section in JSON format to m_JSONbuffer This is the ordered list of stackup l...
void addJSONFilesAttributes()
Add the Files Attributes section in JSON format to m_JSONbuffer.
nlohmann::ordered_json m_json
bool CreateJobFile(const wxString &aFullFilename)
Creates a Gerber job file.
void addJSONGeneralSpecs()
Add the General Specs in JSON format to m_JSONbuffer.
bool WriteJSONJobFile(const wxString &aFullFilename)
Creates an Gerber job file in JSON format.
double mapValue(double aUiValue)
A helper function to convert a double in Pcbnew internal units to a JSON double value (in mm),...
const char * sideKeyValue(enum ONSIDE aValue)
void addJSONDesignRules()
Add the Design Rules section in JSON format to m_JSONbuffer.
std::string formatStringFromUTF32(const wxString &aText)
A helper function to convert a wxString ( therefore a Unicode text ) to a JSON compatible string (a e...
GERBER_JOBFILE_WRITER(BOARD *aPcb, REPORTER *aReporter=nullptr)
wxArrayString m_GerberFileList
std::vector< PCB_LAYER_ID > m_LayerId
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:49
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
Definition: pad.h:54
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:72
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
const wxString & GetRevision() const
Definition: title_block.h:86
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
Definition: common.cpp:59
#define _(s)
wxString GbrMakeProjectGUIDfromString(const wxString &aText)
Build a project GUID using format RFC4122 Version 1 or 4 from the project name, because a KiCad proje...
wxString GbrMakeCreationDateAttributeString(GBR_NC_STRING_FORMAT aFormat)
Handle special data (items attributes) during plot.
@ GBR_NC_STRING_FORMAT_GBRJOB
Definition: gbr_metadata.h:63
Classes used to generate a Gerber job file in JSON.
@ SIDE_BOTTOM
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition: layer_ids.h:581
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ User_8
Definition: layer_ids.h:131
@ F_CrtYd
Definition: layer_ids.h:116
@ B_Adhes
Definition: layer_ids.h:103
@ Edge_Cuts
Definition: layer_ids.h:112
@ Dwgs_User
Definition: layer_ids.h:107
@ F_Paste
Definition: layer_ids.h:104
@ Cmts_User
Definition: layer_ids.h:108
@ User_6
Definition: layer_ids.h:129
@ User_7
Definition: layer_ids.h:130
@ F_Adhes
Definition: layer_ids.h:102
@ B_Mask
Definition: layer_ids.h:98
@ B_Cu
Definition: layer_ids.h:65
@ User_5
Definition: layer_ids.h:128
@ Eco1_User
Definition: layer_ids.h:109
@ F_Mask
Definition: layer_ids.h:97
@ B_Paste
Definition: layer_ids.h:105
@ User_9
Definition: layer_ids.h:132
@ F_Fab
Definition: layer_ids.h:119
@ Margin
Definition: layer_ids.h:113
@ F_SilkS
Definition: layer_ids.h:100
@ B_CrtYd
Definition: layer_ids.h:115
@ Eco2_User
Definition: layer_ids.h:110
@ In1_Cu
Definition: layer_ids.h:66
@ User_3
Definition: layer_ids.h:126
@ User_1
Definition: layer_ids.h:124
@ B_SilkS
Definition: layer_ids.h:101
@ User_4
Definition: layer_ids.h:127
@ User_2
Definition: layer_ids.h:125
@ F_Cu
Definition: layer_ids.h:64
@ B_Fab
Definition: layer_ids.h:118
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_ACTION
std::vector< FAB_LAYER_COLOR > dummy
const std::vector< FAB_LAYER_COLOR > & GetStandardColors(BOARD_STACKUP_ITEM_TYPE aType)
const double IU_PER_MM
Definition: base_units.h:76
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
Definition of file extensions used in Kicad.