updated README.md
This commit is contained in:
Edward Kisiel
293
README.md
293
README.md
@@ -10,7 +10,300 @@ License: GPLv3.
|
||||
|
||||
|
||||
|
||||
### Install
|
||||
|
||||
git clone https://github.com/hominoids/SBC_Case_Builder.git; cd SBC_Case_Builder
|
||||
git submodule init
|
||||
git submodule update
|
||||
|
||||
### Notes
|
||||
|
||||
More information can be found at this [Hard Kernel forum thread](https://forum.odroid.com/viewtopic.php?f=53&t=43948)
|
||||
|
||||
### Case Designs and Styles
|
||||
The case naming convention for standard cases in the configuration file follow the basic form of “sbc”_”design”_”style” e.g. c4_shell or c4_tray_vu5.
|
||||
|
||||
Current Case Count 114
|
||||
Odorid-C1+ cases - 12 : c1+_shell,c1+_panel,c1+_panel_lcd3.5,c1+_desktop_lcd3.5,c1+_stacked,c1+_tray,c1+_tray_sides,c1+_tray_vu5,
|
||||
c1+_tray_vu7,c1+_shell_boombox,c1+_panel_boombox,c1+_tray_boombox
|
||||
Odorid-C2 cases - 13 : c2_shell,c2_panel,c2_panel_lcd3.5,c2_desktop_lcd3.5,c2_stacked,c2_tray,c2_tray_sides,c2_tray_vu5,
|
||||
c2_tray_vu7,c2_shell_boombox,c2_panel_boombox,c2_deskboom_lcd3.5,c2_tray_boombox,
|
||||
Odorid-C4 cases - 13 : c4_shell,c4_panel,c4_panel_lcd3.5,c4_desktop_lcd3.5,c4_stacked,c4_tray,c4_tray_sides,c4_tray_vu5,
|
||||
c4_tray_vu7,c4_shell_boombox,c4_panel_boombox,c4_deskboom_lcd3.5,c4_tray_boombox
|
||||
Odorid-HC4 cases - 11 : hc4_shell,hc4_shell_drivebox2.5,hc4_shell_drivebox2.5v,hc4_shell_drivebox3.5,hc4_panel,hc4_stacked
|
||||
,hc4_tray,hc4_tray_sides,hc4_tray_vu5,hc4_tray_vu7,hc4_tray_drivebox2.5
|
||||
Odorid-N1 cases - 7 : n1_shell,n1_panel,n1_stacked,n1_tray,n1_tray_sides,n1_tray_vu5,n1_tray_vu7
|
||||
Odorid-N2 cases - 5 : n2_panel,n2_tray,n2_tray_sides,n2_tray_vu5,n2_tray_vu7
|
||||
Odorid-N2+ cases - 5 :n2+_panel,n2+_tray,n2+_tray_sides,n2+_tray_vu5,n2+_tray_vu7
|
||||
Odorid-XU4 cases - 7 : xu4_shell,xu4_panel,xu4_stacked,xu4_tray,xu4_tray_sides,xu4_tray_vu5,xu4_tray_vu7
|
||||
Odorid-XU4Q cases - 7 : xu4q_shell,xu4q_panel,xu4q_stacked,xu4q_tray,xu4q_tray_sides,xu4q_tray_vu5,xu4q_tray_vu7
|
||||
Odroid-MC1 cases - 0
|
||||
Odroid-HC1 cases - 0
|
||||
Odroid-HC2 cases - 0
|
||||
Odroid-H2 cases - 13 : h2_shell,h2_lowboy,h2_lowboy_router,h2_shell_router,h2_shell_routerssd,h2_panel,h2_stacked,h2_tray,h2_tray_sides,
|
||||
h2_tray_vu5,h2_tray_vu7,h2_tray_router,h2_router_station
|
||||
Odroid-Show2 cases - 1 : show2_shell
|
||||
Other cases - 10 : jetsonnano_shell,jetsonnano_panel,jetsonnano_stacked,jetsonnano_tray,jetsonnano_tray_sides,
|
||||
rockpro64_shell,rockpro64_panel,rockpro64_stacked,rockpro64_tray,rockpro64_tray_sides
|
||||
rpi3b+_shell,rpi3b+_panel,rpi3b+_stacked,rpi3b+_tray
|
||||
|
||||
### Case and Accessory Schema
|
||||
The schema for case configuration and accessories is documented in the beginning of the file sbc_case_builder.cfg. It has not been finalized and may be subject to changes in the near future as development in these areas is ongoing. Here is a review of the current schema which will be updated as needed for each release. The schema is divided into two areas, case and accessories. There are 30 fixed entries that describe any given case followed by an unlimited number of accessory entries each containing 14 entries.
|
||||
|
||||
schema:
|
||||
|
||||
"case_name","sbc_model","case_design","case_style",
|
||||
pcb_loc_x,pcb_loc_y,pcb_loc_z,case_offset_x,case_offset_y,case_offset_tz,case_offset_bz,
|
||||
wallthick,floorthick,sidethick,gap,fillet,
|
||||
indents,sidewall_support,sbc_top_standoffs,sbc_bottom_standoffs,case_ext_standoffs,mode
|
||||
sata_punchout,"gpio_opening","cooling","exhaust_vents",
|
||||
top_standoff[ 6.75, // diameter
|
||||
18, // height (top_height)
|
||||
2.5, // holesize
|
||||
10, // supportsize
|
||||
4, // supportheight
|
||||
4, // 0=none, 1=countersink, 2=recessed hole, 3=nut holder, 4=blind hole
|
||||
0, // standoff style 0=hex, 1=cylinder
|
||||
1, // enable reverse standoff
|
||||
0, // enable insert at top of standoff
|
||||
4.5, // insert hole dia. mm
|
||||
5.1], // insert depth mm
|
||||
bottom_standoff[ 6.75, // diameter
|
||||
5, // height (bottom_height-pcb_z)
|
||||
3.6, // holesize
|
||||
10, // supportsize
|
||||
4, // supportheight
|
||||
1, // 0=none, 1=countersink, 2=recessed hole, 3=nut holder, 4=blind hole
|
||||
0, // standoff style 0=hex, 1=cylinder
|
||||
0, // enable reverse standoff
|
||||
0, // enable insert at top of standoff
|
||||
4.5, // insert hole dia. mm
|
||||
5.1], // insert depth mm
|
||||
top_ext_standoff[ 6.75, // diameter
|
||||
18, // height (top_height)
|
||||
2.5, // holesize
|
||||
10, // supportsize
|
||||
4, // supportheight
|
||||
4, // 0=none, 1=countersink, 2=recessed hole, 3=nut holder, 4=blind hole
|
||||
0, // standoff style 0=hex, 1=cylinder
|
||||
1, // enable reverse standoff
|
||||
0, // enable insert at top of standoff
|
||||
4.5, // insert hole dia. mm
|
||||
5.1], // insert depth mm
|
||||
bottom_ext_standoff[ 6.75, // diameter
|
||||
5, // height (bottom_height-pcb_z)
|
||||
3.6, // holesize
|
||||
10, // supportsize
|
||||
4, // supportheight
|
||||
1, // 0=none, 1=countersink, 2=recessed hole, 3=nut holder, 4=blind hole
|
||||
0, // standoff style 0=hex, 1=cylinder
|
||||
0, // enable reverse standoff
|
||||
0, // enable insert at top of standoff
|
||||
4.5, // insert hole dia. mm
|
||||
5.1], // insert depth mm
|
||||
|
||||
"class","type",loc_x,loc_y,loc_z,face,rotation[],size_x,size_y,size_z,data_1,data_2,"data_3",data_4[]
|
||||
|
||||
Fixed Schema Entries
|
||||
The 30 fixed schema entries are self-evident based on their name.
|
||||
|
||||
case_name = “case_name”
|
||||
sbc_model = any sbc from sbc model framework: "c1+","c2","c4","hc4","xu4","xu4q","mc1","hc1","n1","n2","n2+","h2"
|
||||
case_design = "shell", "panel", "stacked", "tray"
|
||||
case_style = “style” of case_design (tray: none, vu5, vu7)
|
||||
pcb_loc_x = sbc location x axis
|
||||
pcb_loc_y = sbc location y axis
|
||||
pcb_loc_z = sbc location z axis
|
||||
case_offset_x = additional case x axis size
|
||||
case_offset_y = additional case y axis size
|
||||
case_offset_tz = additional case top z axis size
|
||||
case_offset_bz = additional case bottom z axis size
|
||||
wallthick = case wall thickness
|
||||
floorthick = case floor thickness
|
||||
sidethick = case side thickness
|
||||
gap = distance between pcb and case
|
||||
fillet = edge fillets
|
||||
indents = enable indentations around io openings (true or false)
|
||||
sidewall_support = enable wall support for standoffs (true or false)
|
||||
sbc_top_standoffs = enable sbc top standoffs (true or false)
|
||||
sbc_bottom_standoffs = enable sbc bottom standoffs (true or false)
|
||||
case_ext_standoffs = enable case extended standoffs (true or false)
|
||||
sata_punchout = enable sata punchout (true or false)
|
||||
gpio_opening = gpio openings "none","vent","open","punchout"
|
||||
cooling = "none", "vents", "fan", "custom" using ./dxf/customfan.dxf
|
||||
exhaust_vents = exhaust vents "none","vent"
|
||||
top_standoff[] = top pcb standoffs
|
||||
bottom_standoff[] = bottom pcb standoffs
|
||||
top_ext_standoff[] = top extended standoffs
|
||||
bottom_ext_standoff[] = bottom extended standoffs
|
||||
mode = special mode "net_card"
|
||||
|
||||
### Accessories Configuration Entries
|
||||
The accessories entries need more explanation because of their input variability. For accessories there are 6 classes, “add1”,“sub”,”suball”,”add2”,”model”,”platter” and all use the same command format for various “type”.
|
||||
|
||||
"class","type",loc_x,loc_y,loc_z,size_x,size_y,size_z,"face",rotation[],data_1,data_2,"data_3",data_4[]
|
||||
|
||||
Code: Select all
|
||||
|
||||
"sub","rectangle",3,78,-.1,8,8,5,"bottom",[0,0,0,],0,0,"",[1,1,1,1],
|
||||
|
||||
Every type, regardless of it’s class, uses a basic set of variables(loc_x,loc_y,loc_z,”face”,rotation[]) but each type doesn’t necessarily use all available data fields(size_x,size_y,size_z,data_1,data_2,”data_3”,data_4[]). “add1” and “add2” are used to add geometry to the case. The difference is when the addition occurs. “add1” happens at the beginning when the core case geometry is created and add2 happens after all subtractions have occurred. “suball” is used to affect all faces of a case, not just “face”. The “face” is the case piece that will be effected by the addition or subtraction. The "model" type is for placing supporting accessories in the model view. e.g. hard drives, fans. The "platter" type is for adding supporting accessories to the print platter.
|
||||
|
||||
classes: add1, sub, suball, add2, model, platter
|
||||
|
||||
additive type: circle, rectangle, slot, text, art, standoff, batt_holder, uart_holder, hd_holder, hd_holes, hd_vertright_holes, hc4_oled_holder, access_port, button, pcb_holder, boom_grill, boom_speaker_holder
|
||||
subtractive type: circle, rectangle, slot, text, art, punchout, vent, fan, hd_holes, hd_vertleft_holes, hd_vertright_holes
|
||||
model type: uart_strap, fan_cover, hd25, hd35, hc4_oled, feet, access_cover, net_card, hk35_lcd, hk_boom, boom_speaker, boom_vring, hk_uart
|
||||
platter type: uart_strap, fan_cover, access_cover, button_top, boom_vring
|
||||
|
||||
#### Shared add and sub “type” commands
|
||||
-circle
|
||||
description: circlular geometry.
|
||||
uses: size_x=dia, size_z=height
|
||||
-rectangle
|
||||
description: rectangular geometry with individual defined corner fillets. Radius1 is lower left corner then moves clockwise.
|
||||
uses: size_x, size_y, size_z, data_4=[radius1, radius2, radius3, radius4]
|
||||
-slot
|
||||
description: slot geometry.
|
||||
uses: size_x=diameter, size_y=length, size_z=height
|
||||
-text
|
||||
description: raised or sunk text
|
||||
uses: data_1=size, data_3="text"
|
||||
-art
|
||||
description: art work in dxf or svg format
|
||||
uses: data_1=scale, data_2=height, data_3=file
|
||||
|
||||
#### Add class only “types”
|
||||
-uart_holder
|
||||
description: console uart holder
|
||||
uses: none
|
||||
-batt_holder
|
||||
description: rtc battery holder
|
||||
uses: none
|
||||
-standoff
|
||||
description: user defined standoff
|
||||
uses: data_4=
|
||||
|
||||
[ 6.75, // radius
|
||||
5, // height
|
||||
3.6, // holesize
|
||||
10, // supportsize
|
||||
4, // supportheight
|
||||
1, // 0=none, 1=countersink, 2=recessed hole, 3=nut holder, 4=blind hole
|
||||
0, // standoff style 0=hex, 1=cylinder
|
||||
0, // enable reverse standoff
|
||||
0, // enable insert at top of standoff
|
||||
4.5, // insert hole dia. mm
|
||||
5.1] // insert depth mm
|
||||
|
||||
-hd_holder
|
||||
description: double stacked holder for 2.5 and 3.5 drives
|
||||
uses: data_1=2.5 or 3.5, data_3=”portrait” or “landscape”
|
||||
-hd_vertleft_holder
|
||||
description: vertical left side holder for 2.5 and 3.5 drives
|
||||
uses: data_1=2.5 or 3.5, data_3=”portrait” or “landscape”
|
||||
-hd_vertright_holder
|
||||
description: vertical right side holder for 2.5 and 3.5 drives
|
||||
uses: data_1=2.5 or 3.5, data_3=”portrait” or “landscape”
|
||||
-hc4_oled_holder
|
||||
description: hc4 oled holder
|
||||
uses: size_z=floorthick
|
||||
-access_port
|
||||
description: bottom access for sd and emmc
|
||||
uses: size_z=floorthick, data_3=”portrait” or “landscape”
|
||||
-button
|
||||
description: button top and plunger
|
||||
uses: size_x=diameter,size_z=height, data_3=”reccess”
|
||||
-pcb_holder
|
||||
description: pcb bottom edge holder
|
||||
uses: size_x=pcb_x,size_y=pcb_y,size_z=pcb_z, data_1=wall_thick
|
||||
-boom_grill
|
||||
description: hk boom bonnet grill covers
|
||||
uses: data_3="flat", "dome", "frame"
|
||||
-boom_speaker_holder
|
||||
description: hk boom bonnet speaker friction holder
|
||||
uses: data_1=tolorence
|
||||
|
||||
#### Sub class only “types”
|
||||
-punchout
|
||||
description: punchout in rectangle, round or slot shape
|
||||
uses: size_x=width, size_y=depth, data_1=gap, size_z=thick, data_2=fillet, data_3="rectangle","round" or "slot"
|
||||
-vent
|
||||
description: horizontal or vertical vent openings
|
||||
uses: size_x=open_width, size_y=open_length, size_z=thick, data_4=gap, data_1=rows, data_3=columns, data_3=orientation("vertical","horizontal")
|
||||
-fan
|
||||
description: fan opening
|
||||
uses: size_x=size, size_z=thick, date_1=style(1=open,2=fan)
|
||||
-hd_holes
|
||||
description: bottom hole pattern for 2.5 or 3.5 drives
|
||||
uses: data_1=2.5 or 3.5, data_2=thick, data_3=”portrait” or “landscape”
|
||||
-hd_vertleft_holes
|
||||
description: bottom hole pattern for 2.5 or 3.5 drives
|
||||
uses: data_1=2.5 or 3.5, data_2=thick, data_3=”portrait” or “landscape”
|
||||
-hd_vertright_holes
|
||||
description: bottom hole pattern for 2.5 or 3.5 drives
|
||||
uses: data_1=2.5 or 3.5, data_2=thick, data_3=”portrait” or “landscape”-component mask(incomplete)
|
||||
|
||||
#### Model class “types”
|
||||
-uart_strap
|
||||
description: console uart holder strap
|
||||
uses: none
|
||||
-fan_cover
|
||||
description: cover for fan hole opening
|
||||
uses: size_x=40 or 80, size_z=thick
|
||||
-hd25
|
||||
description: 2.5 hard drive
|
||||
uses: data_1=height
|
||||
-hd35
|
||||
description: 3.5 hard drive
|
||||
uses: none
|
||||
-hc4_oled
|
||||
description: hc4_oled model
|
||||
uses: none
|
||||
-feet
|
||||
description: case feet
|
||||
uses: size_x=diameter, size_z=height
|
||||
-access_cover
|
||||
description: bottom access cover for sd and emmc
|
||||
uses: size_z=floorthick, data_3=”portrait” or “landscape”
|
||||
-button_top
|
||||
description: button top and plunger
|
||||
uses: size_x=diameter,size_z=height, data_3=”reccess”
|
||||
-h2_netcard
|
||||
description: h2 network card model
|
||||
uses: none
|
||||
-hk_lcd35
|
||||
description: hk 3.5 inch lcd model
|
||||
uses: none
|
||||
-hk_boom
|
||||
description: hk stereo boom bonnet model
|
||||
uses: data_1=speakers(true or false), data_3=”front” or "rear"
|
||||
-boom_speaker
|
||||
description: hk stereo boom bonnet speaker
|
||||
uses: data_1=pcb(true or false), data_3=”left” or "right"
|
||||
-hk_speaker
|
||||
description: hk speaker model
|
||||
uses: none
|
||||
-boom_vring
|
||||
description: hk stereo boom bonnet volume wheel extention
|
||||
uses: data_1=tolerence
|
||||
-hk_uart
|
||||
description: hk console uart model
|
||||
uses: none
|
||||
|
||||
#### Platter class “types”
|
||||
-uart_strap
|
||||
description: console uart holder strap
|
||||
uses: none
|
||||
-fan_cover
|
||||
description: cover for fan hole opening
|
||||
uses: size_x=40 or 80, size_z=thick
|
||||
-access_cover
|
||||
description: bottom access cover for sd and emmc
|
||||
uses: size_z=floorthick, data_3=”portrait” or “landscape”
|
||||
-button_top
|
||||
description: button top and plunger
|
||||
uses: size_x=diameter,size_z=height, data_3=”reccess”
|
||||
-boom_vring
|
||||
description: hk stereo boom bonnet volume wheel extention
|
||||
uses: data_1=tolerence
|
||||
|
||||
Reference in New Issue
Block a user