[HOW] Use pcb_print_testpoints.kibot.yaml in my project

[MarkusSBS]

Describe the bug
I have testet the example yaml https://github.com/INTI-CMNB/KiBot/blob/master/tests/yaml_samples/pcb_print_testpoints.kibot.yaml but it didnt work.

The filter is not Selecting the test point and instead Highlighting some other objects.

To Reproduce
use the sample yaml with a pcb with a testpoint

  - name: only_pdf_tp
    comment: "Select only testpoints"
    type: generic
    include_only:
      - column: Value
        regex: "^TestPoint"  

  - name: 'tp_pdf'
    comment: "PDF for Testpoint location"
    type: pcb_print
    dir: PCB_Docu/Testpoints
    output_id: 'Testpoint-Location'
    options:
      variant: ''
      format: 'PDF'
      output: "${SBS_SAP}_%p-%v_Rev%r-%i_${SBS_Doc_status}_%D-${git_hash}.%x" 
      realistic_solder_mask: false
      keep_temporal_files: false
      scaling: 1.0
      colored_pads: false
      colored_vias: false
      pages:
        - sheet: Front
          sheet_reference_color: "#A02020"
          sketch_pads_on_fab_layers: true
          sketch_pad_line_width: 1
          layers:
            - layer: Edge.Cuts
              color: '#A0A0A0'
            - layer: F.Cu
              color: '#A0A0A0'
            - layer: F.SilkS
              color: '#A0A0A0'
            - layer: F.Fab
              plot_footprint_refs: false
              plot_footprint_values: false
              color: '#202020'
            - layer: F.Fab
              exclude_filter: 'only_pdf_tp'
              color: '#FF0000'
              plot_footprint_values: false
              sketch_pads_on_fab_layers: false
            - layer: Dwgs.User

Screenshots

Environment (please complete the following information):
Where are you running KiBot:

• In a CI/CD workflow? gitlab

• Using a docker image? ghcr.io/inti-cmnb/kicad9_auto_full:devone?

• Using a desktop system? Windows

[set-soft]

Hallo @MarkusSBS !

You must provide some example. I don't know what are the testpoints in your circuit, or how do you define them, hence a picture won't help.
Make sure the Value field of your testpoints starts with "TestPoint", this is what the filter is looking for, otherwise change the filter.

You can see it working like this:

kibot -c tests/yaml_samples/pcb_print_testpoints.kibot.yaml -b tests/board_samples/kicad_9/test_points.kicad_pcb -d pp

Which generates:

[MarkusSBS]

I sended you my test projekt the testpoints are a mix out of the standart Testpoints from kicad my own but it does not work with both

[MarkusSBS]

with this it is not possible print only the ref and value of the testpoints? you can just change the color?

[set-soft]

I sended you my test projekt the testpoints are a mix out of the standart Testpoints from kicad my own but it does not work with both

The problem here is that you are using the example filter, which assumes your testpoints are just like KiCad creates them, with Value=TestPoint* and you are naming them using the net name.

The only testpoint that is marked is TP5.

In your particular case this filter works:

filters:
  - name: only_testpoints
    comment: "Select only testpoints"
    type: generic
    include_only:
      - column: Value
        regex: "^TestPoint"
      - column: TestPointLogicType
        regex: "\\S+"

About the "other things", you are excluding all other footprints, but you have text in F.Fab that doesn't belong to any footprint, so it can't be filtered. You can move it to other layer, or put them inside some footprint (which is quite annoying to handle).

with this it is not possible print only the ref and value of the testpoints? you can just change the color?

I'm not sure what you want, this example is about displaying them in a particular color.
And it is oriented to change the color of their associated drawings in the Fab layer. This is what the exclude filter does in the Fab layer. In this case we can just apply it to a layer of the print instead of to the whole output.
You can create a table containing the testpoints and their positions, but this is more complex. It involves two passes, in one you generate the information and in the other you "paste" it in the PCB.

You can get something like this:

This particular example was created in 3 steps, just because the test files are from different examples:

kibot -c tests/yaml_samples/test_points_table_1.kibot.yaml -b tests/board_samples/kicad_9/test_points.kicad_pcb -d pp -s all
kibot -c tests/yaml_samples/test_points_table_1.kibot.yaml -b tests/board_samples/kicad_9/test_points.kicad_pcb -d pp -i
kibot -c tests/yaml_samples/pcb_print_testpoints.kibot.yaml -b tests/board_samples/kicad_9/test_points.kicad_pcb -d pp

The first call generates the CSVs (the tables). The second pastes the tables in the PCB (using include_table preflight). And the third prints the PCB.

The last two can be done in the same run.

[MarkusSBS]

i have fixed the fab layer and tryed your filter but still no highlighting:

  - name: only_pdf_tp
    comment: "Select only testpoints"
    type: generic
    include_only:
      - column: Value
        regex: "^TestPoint"
      - column: TestPointLogicType
        regex: "\\S+"

tp5 is a standart Kicad testpoint fresh out of the libery

[set-soft]

Using:

# Example KiBot config file
kibot:
  version: 1

filters:
  - name: only_testpoints
    comment: "Select only testpoints"
    type: generic
    include_only:
      - column: Value
        regex: "^TestPoint"
      - column: TestPointLogicType
        regex: "\\S+"

outputs:
  - name: 'print_front'
    comment: "Print Top layer, testpoints in red"
    type: pcb_print
    dir: Layers
    options:
      format: 'PDF'
      keep_temporal_files: true
      colored_pads: false
      colored_vias: false
      pages:
        - sheet: Front
          sheet_reference_color: "#A02020"
          sketch_pads_on_fab_layers: true
          sketch_pad_line_width: 1
          layers:
            - layer: Edge.Cuts
              color: '#A0A0A0'
            - layer: F.Fab
              exclude_filter: 'only_testpoints'
              color: '#FF0000'
              plot_footprint_values: false
              sketch_pads_on_fab_layers: false

And the PCB you sent me I get:

Try the above mentioned config.

[MarkusSBS]

hm with config in my config file i get only a blank page

- name: 'tp_pdf'
    comment: "Print Top layer, testpoints in red"
    type: pcb_print
    dir: Layers
    options:
      format: 'PDF'
      keep_temporal_files: true
      colored_pads: false
      colored_vias: false
      pages:
        - sheet: Front
          sheet_reference_color: "#A02020"
          sketch_pads_on_fab_layers: true
          sketch_pad_line_width: 1
          layers:
            - layer: Edge.Cuts
              color: '#A0A0A0'
            - layer: F.Fab
              exclude_filter: 'only_pdf_tp'
              color: '#FF0000'
              plot_footprint_values: false
              sketch_pads_on_fab_layers: false

  - name: only_pdf_tp
    comment: "Select only testpoints"
    type: generic
    include_only:
      - column: Value
        regex: "^TestPoint"
      - column: TestPointLogicType
        regex: "\\S+"
       

[set-soft]

Hallo @MarkusSBS !

I see you still paste pieces of configs. Did you try the example from the repo?

I tried (again) using what you pasted above:

kibot:
  version: 1

filters:
  - name: only_pdf_tp
    comment: "Select only testpoints"
    type: generic
    include_only:
      - column: Value
        regex: "^TestPoint"
      - column: TestPointLogicType
        regex: "\\S+"
       
outputs:
  - name: 'tp_pdf'
    comment: "Print Top layer, testpoints in red"
    type: pcb_print
    dir: Layers
    options:
      format: 'PDF'
      keep_temporal_files: true
      colored_pads: false
      colored_vias: false
      pages:
        - sheet: Front
          sheet_reference_color: "#A02020"
          sketch_pads_on_fab_layers: true
          sketch_pad_line_width: 1
          layers:
            - layer: Edge.Cuts
              color: '#A0A0A0'
            - layer: F.Fab
              exclude_filter: 'only_pdf_tp'
              color: '#FF0000'
              plot_footprint_values: false
              sketch_pads_on_fab_layers: false

And the file you sent me (just removed the worksheet, which isn't in the ZIP), and I get:

In order to isolate your problem you must try with the same stuff.

[MarkusSBS]

- 'kibot -d Docu -g variant=echo $CI_COMMIT_TAG | cut -d "_" -f4 | tr -d "\n" -s tp_pdf hm with this it does not work

but this works - 'kibot -d Docu -s drc,erc tp_pdf' and i dont understand why? it just set the variant to PROD if it is triggered by my tag

Is it not possible to use this with a variant? (not that problematic but may be a small problem in the future

[MarkusSBS]

maybe i missunderstand some principals of kibot? or do i have some other majore problems with my config?

[set-soft]

Variants can define exclude_filters, if your variant removes the testpoints then the exclude_filter on the layer won't work because the testspoints are already removed.

You can use -vvv to get debug information which usually contains detailed information about which filters are applied and which references are excluded.