Skip to content

Commit 0d378a6

Browse files
committed
chore: update Docusaurus dependencies to version 3.9.1 and add new Mermaid layout dependency
refactor: clean up sidebar configuration by removing commented categories and updating module structure style: improve CSS formatting for menu and search components for better readability fix: correct highlight color in color definitions to use lowercase hex values style: enhance font-face declarations for better readability in CSS files chore: update firmware JSON files with new packages and versions for various boards docs: update README for fobe_idea_mesh_tracker_c1 to remove unnecessary whitespace feat: add new banner image for fobe module fix: correct syntax in code block copy button script for better functionality
1 parent 2c208a3 commit 0d378a6

File tree

30 files changed

+1814
-1320
lines changed

30 files changed

+1814
-1320
lines changed

.vscode/extensions.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
{
2-
"recommendations": [
3-
"mushan.vscode-paste-image"
4-
]
5-
}
2+
"recommendations": ["mushan.vscode-paste-image"]
3+
}

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
"pasteImage.path": "${projectRoot}/static/img/screenshot",
33
"pasteImage.defaultName": "Y-MM-DD-HH-mm-ss",
44
"pasteImage.insertPattern": "<br/><div style={{ textAlign: 'center' }}><img src=\"/img/screenshot/${imageFileName}\" alt=\"${imageFileName}\" style={{ width: '80%', height: 'auto' }} /></div><br/>"
5-
}
5+
}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# FoBE Documentation
1+
# FoBE Documentation

cspell.json

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,47 @@
5353
"Xtensa",
5454
"PSRAM",
5555
"TWAI",
56-
"JTAG"
56+
"JTAG",
57+
"meshbus",
58+
"micropython",
59+
"circuitpython",
60+
"OLED",
61+
"SWCLK",
62+
"SWDIO",
63+
"IPEX",
64+
"sublist",
65+
"SWRST",
66+
"Keil",
67+
"Mbed",
68+
"stlink",
69+
"stlinks",
70+
"cmsis",
71+
"Linearin",
72+
"Kbit",
73+
"GLONASS",
74+
"AGNSS",
75+
"QZSS",
76+
"Quectel",
77+
"TTFF",
78+
"NMEA",
79+
"ScioSense",
80+
"HVAC",
81+
"TVOC",
82+
"JEDEC",
83+
"JESD",
84+
"TCXO",
85+
"MOSI",
86+
"RXEN",
87+
"Vout",
88+
"TCXO",
89+
"optimised",
90+
"GDMA",
91+
"Thaaaaaat's",
92+
"PETG",
93+
"QDEC",
94+
"ksps",
95+
"Radionica",
96+
"Modulino"
5797
],
5898
"allowCompoundWords": true,
5999
"useGitignore": true,

docs/index.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,13 @@ Learn about hardware and software using tutorials and developer guides.
7272

7373
[<Minimize2 size={16} strokeWidth={1.5}/> **IDEA** _Multi-functional integrated creative prototyping board._](/product/idea)
7474

75-
[<CircuitBoard size={16} strokeWidth={1.5}/> **DevKit ```Coming soon```** _UNO-compatible MCU board with integrated debugger._](/product/devkit)
7675

77-
[<Blocks size={16} strokeWidth={1.5}/> **Shield ```Coming soon```** _Professional functional integration evaluation board._](/product/shield)
78-
79-
[<Blocks size={16} strokeWidth={1.5}/> **Core ```Coming soon```** _Module designed for a wide range of IoT applications._](/product/core)
76+
[<Blocks size={16} strokeWidth={1.5}/> **Module** _Module designed for a wide range of IoT applications._](/product/module)
8077

8178
</Chapters>
8279
</Block>
8380

84-
{/* <Block title="Solutions" >
81+
<Block title="Solutions" >
8582
<Chapters>
8683
[<Earth size={16} strokeWidth={1.5}/> **Environmental Telemetry** _Build reliable environmental monitoring systems with MicroPython._](solutions/env-telemetry)
8784

@@ -93,4 +90,4 @@ Learn about hardware and software using tutorials and developer guides.
9390

9491
[<LayoutDashboard size={16} strokeWidth={1.5}/> **FoBE DPC** _High-concurrency IoT data processing platform._](solutions/dpc)
9592
</Chapters>
96-
</Block> */}
93+
</Block>

docs/product/base.mdx

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/product/core.mdx

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/product/devkit.mdx

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/product/f6001/quickstart.mdx

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,4 @@ FoBE Core nRF52840 Mesh is a single-sided 15.24mm x 25.4mm 1.6mm thick PCB with
2727

2828
## Pinout
2929

30-
All nRF52840 pins are available as 90 pads (including GND) on the module. Please refer to the nRF52840 datasheet for detailed pin descriptions and functionalities.
31-
32-
## Programming
33-
34-
### Development Environment Setup
35-
36-
To start developing applications for the FoBE Core nRF52840 Mesh, you'll need to set up a development environment. Here are the recommended steps:
37-
38-
1. **Install the Arduino IDE:** Download and install the latest version of the Arduino IDE from the official Arduino website.
39-
2. **Install the Board Support Package (BSP):** Add the necessary board support package for the nRF52840 to the Arduino IDE. This will allow you to compile and upload code to the module.
40-
3. **Install LoRaWAN library:** You can use the [MCCI LoRaWAN LMIC library](https://github.com/mcci-catena/arduino-lmic) to develop LoRaWAN applications.
41-
42-
### Example Code
43-
44-
Here's a simple example of sending a LoRaWAN message using the FoBE Core nRF52840 Mesh:
45-
46-
```C++
47-
// filepath: example.cpp
48-
#include <lmic.h>
49-
#include <SPI.h>
50-
```
51-
52-
**Note:** This is a basic example and may require adjustments based on your specific LoRaWAN network and configuration.
30+
All nRF52840 pins are available as 90 pads (including GND) on the module. Please refer to the nRF52840 datasheet for detailed pin descriptions and functionalities.

docs/product/module.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Module
3+
hide_title: true
4+
---
5+
6+
import Link from '@docusaurus/Link';
7+
8+
<br/>
9+
<br/>
10+
<div style={{ display: 'flex', alignItems: 'center', flexWrap: 'wrap' }}>
11+
<img src="/img/apps/fobe.module.banner.png" alt="FoBE Core series" style={{ width: '30%', height: 'auto', borderRadius: '10px', maxWidth: '320px'}} />
12+
</div>
13+
<br/>
14+
15+
The **FoBE Module** series are multi-protocol wireless communication modules designed for compact spaces, integrating various advanced features and suitable for smart home, IoT devices, and industrial automation applications.
16+
17+
## Series Comparison
18+
<table style={{ width: '100%'}}>
19+
<tbody>
20+
<tr>
21+
<td>SKU</td>
22+
<td>Name</td>
23+
<td>Description</td>
24+
</tr>
25+
<tr>
26+
<td>F6001</td>
27+
<td style={{ fontWeight: 'bold', width: '40%' }} ><Link to="/product/f6001">FoBE Core nRF52840 Mesh</Link></td>
28+
<td>FoBE Core nRF52840 Mesh combines the nRF52840 MCU and SX1262 LoRa transceiver for long-range, low-power IoT applications. All pins are available via 90 pads.</td>
29+
</tr>
30+
</tbody>
31+
</table>

0 commit comments

Comments
 (0)