Skip to content

Commit 5652b5b

Browse files
Template for New GNSS Flex Modules
Introduces initial documentation structure, image assets, and configuration files for SparkPNT GNSS Flex Modules. Includes README files for asset directories, banner images, initial image templates for documentation, and a starter mkdocs.yml configuration.
1 parent feedaeb commit 5652b5b

25 files changed

+160
-0
lines changed
319 KB
Loading
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
3d_model directory
2+
====================
3+
This folder should contain the 3D model of the product
4+
5+
## Solder Mask - Color Correction Values
6+
Hex: #E0311D
7+
RGB: 224, 49, 29
8+
9+
10+
## File Optimizer
11+
https://glb.babylonpress.org/
12+
13+
- Enable these options
14+
- `Simplify | MeshoptSimplifier`
15+
- `Quantize | KHR_mesh_quantization`
16+
- `Use UASTC Zstandard Supercompression`
17+
- Set these options, to the following values:
18+
- `ETC1S Quality Level (255 = best)`: 73
19+
- `ETC1S Compression Level (0 = fastest)`: 5
20+
21+
### VS Code Extension
22+
To reorder the materials for the rendering, use the [GlTF Tools extension](https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode) in VS Code
23+
24+
- https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode
25+
- https://github.com/AnalyticalGraphicsInc/gltf-vscode
26+
27+
28+
## Model Editor
29+
https://modelviewer.dev/editor/
30+
31+
32+
33+
## Old Methods
34+
35+
### File Converter - `*.wrl` to `*.glb`
36+
https://imagetostl.com/convert/file/wrl/to/glb#convert
37+
38+
### Solder Mask - Color Correction
39+
Open `*.glb` file and locate the `baseColorFactor` parameter with the following values:
40+
```
41+
0.7027450799942017,
42+
0.1537254899740219,
43+
0.0909803956747055,
44+
0.8313725590705872
45+
```
46+
Replace those values with the following values: `[,,,1]`
47+
```
48+
0.7418950796127319,
49+
0.0302486829459667,
50+
0.0122311776503920,
51+
1
52+
```
53+
54+
### Solder Mask - Color Correction
55+
https://3deditoronline.com/
56+
57+
### 1st File Optimizer *(Deprecated)*
58+
https://www.loci-labs.com/optimizer
59+
60+
### 2nd File Optimizer *(Deprecated)*
61+
https://xiehangyun.github.io/gltf-optimization/
62+
63+
- Max Texture Size: 512
64+
- Create Unified Palette Texture for Solid Colors and Merge: *(Unselect)*
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
board_files directory
2+
====================
3+
4+
1. A `dimensions.*` file containing the board's measurements.
5+
2. A `schematic.pdf` file containing the board's schematics.
6+
3. A `*_files.zip` file containing the hardware design files.
7+
- The file name is based on the CAD software used to design the hardware, as described below:
8+
- A `kicad_files.zip` file containing the KiCad design files.
9+
4. If available, a `graphical_datasheet.pdf` containing a summary of the board's technical specifications.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
SparkFun Documentation
2+
=======================
3+
4+
This directory should include any necessary datasheets, example number crunching, etc.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
img directory
2+
====================
3+
This folder should contain the images for the product documentation
4+
5+
## General Images
6+
- `sfe-logo.png` - SparkFun flame logo (favicon)
7+
8+
## Directory
9+
- `graphical_datasheet` - Files for graphical datasheet
10+
- `hookup_guide` - Images for the hookup guide pages
11+
- `qr_code` - QR code images
12+
- `qwiic` - Images for Qwiic Banner
13+
14+
## QR Codes
15+
- [QR code generator](https://qrgenerator.org/)
16+
- Flame Color: #E0311D
17+
- Frame Color: #3C464D
18+
- [Remove meta data from svg](https://jakearchibald.github.io/svgomg/)
319 KB
Loading
Binary file not shown.
320 KB
Loading
2.08 MB
Binary file not shown.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
hookup_guide directory
2+
====================
3+
This folder should contain images for the hookup guide
4+
5+
6+
## Default Image Sizes
7+
8+
- **PCB:** 580px x 750px
9+
- **PCB w/ Border:** 630px x 800px
10+
- **Top & Bottom View:** 1250px x 800px
11+
12+
13+
14+
## Template Files
15+
Files that are inherently included for all GNSS Flex modules
16+
17+
- `animation-attach_module.gif` - Side view for connecting the Flex board
18+
- `animation-attach_module2.gif` - Isometric view for connecting the Flex boards with alignment
19+
- `assembly-ufl_bridge.jpg` - U.FL cable bridging the antenna connection
20+
- `assembly-ufl_connector.jpg` - Attaching the U.FL cable to the GNSS Flex module
21+
- `headers-flex_module.png` - Template for pin connections of the GNSS Flex headers
22+
- `headers-flex_module+gap.png` - Template for pin connections of the GNSS Flex headers w/ gap for 3rd header
23+
- `headers-flex_module+opt.png` - Template for pin connections of the GNSS Flex headers w/ box for 3rd header
24+
- `module-pinout.png` - Pin connections of the GNSS Flex headers with the board w/ alignment marker
25+
- `module-pinout-carrier_height.png` - Pin connections of the GNSS Flex headers with the board, sized to carrier board template
26+
- `module-pinout-carrier_height2.png` - Pin connections of the GNSS Flex headers with the board, sized to carrier board template w/ alignment marker
27+
28+
29+
## Layout Files
30+
Files that are specific to this GNSS Flex module
31+
32+
- `ant.png` - Annotated image of the U.FL connector
33+
- `headers.png` - Annotated image of the GNSS FLex headers
34+
- `jumpers.png` - Annotated image of the jumpers
35+
- `layout.png` - Annotated image for the board layout
36+
- `<GNSS Receiver>.png` - Annotated image of the GNSS receiver
37+
- `orientation.png` - Annotated image of the alignment marker
38+
39+
40+
### Template Images
41+
42+
- `bottom.png` - Template image for the bottom of the board, using the default image size
43+
- `layout-bottom.png` - Template image for the bottom of the board w/ background, using the default image size
44+
- `layout-template.png` - Template image for both sides of the board, using the default image size
45+
- `layout-top.png` - Template image for the top of the board w/ background, using the default image size
46+
- `top.png` - Template image for the top of the board, using the default image size

0 commit comments

Comments
 (0)