Skip to content

Commit 0ea3f29

Browse files
kaklikkaklik
committed
Updating documentation and readme.
1 parent 2aa964c commit 0ea3f29

File tree

8 files changed

+11956
-5132
lines changed

8 files changed

+11956
-5132
lines changed

‎.github/workflows/kicad_outputs.yml

+40-40
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ on:
1313
- '**.yml'
1414
- 'doc/assets'
1515
workflow_dispatch:
16-
16+
1717
env:
1818
schema: "hw/sch_pcb/${{ github.event.repository.name }}.kicad_sch"
1919
board: "hw/sch_pcb/${{ github.event.repository.name }}.kicad_pcb"
@@ -32,15 +32,15 @@ jobs:
3232
submodules: recursive
3333
token: ${{ secrets.pat }}
3434
ref: ${{ github.head_ref }}
35-
36-
- uses: INTI-CMNB/KiBot@v2_dk7
35+
36+
- uses: INTI-CMNB/KiBot@v2_dk8
3737
with:
3838
config: ${{ env.kibot }}/erc.kibot.yaml
3939
schema: ${{ env.schema }}
4040
board: ${{ env.board }}
4141
dir: ${{ env.dir }}
42-
43-
42+
43+
4444
DRC:
4545
runs-on: ubuntu-latest
4646
continue-on-error: true
@@ -50,15 +50,15 @@ jobs:
5050
submodules: recursive
5151
token: ${{ secrets.pat }}
5252
ref: ${{ github.head_ref }}
53-
54-
- uses: INTI-CMNB/KiBot@v2_dk7
53+
54+
- uses: INTI-CMNB/KiBot@v2_dk8
5555
with:
5656
config: ${{ env.kibot }}/drc.kibot.yaml
5757
schema: ${{ env.schema }}
5858
board: ${{ env.board }}
5959
dir: ${{ env.dir }}
60-
61-
60+
61+
6262
schematics:
6363
runs-on: ubuntu-latest
6464
continue-on-error: true
@@ -68,8 +68,8 @@ jobs:
6868
submodules: recursive
6969
token: ${{ secrets.pat }}
7070
ref: ${{ github.head_ref }}
71-
72-
- uses: INTI-CMNB/KiBot@v2_dk7
71+
72+
- uses: INTI-CMNB/KiBot@v2_dk8
7373
with:
7474
config: ${{ env.kibot }}/schematics.kibot.yaml
7575
schema: ${{ env.schema }}
@@ -81,7 +81,7 @@ jobs:
8181
with:
8282
name: doc_sch
8383
path: ${{ env.dir }}_docs/**
84-
84+
8585
placement:
8686
name: "Placement and XML"
8787
runs-on: ubuntu-latest
@@ -92,21 +92,21 @@ jobs:
9292
submodules: recursive
9393
token: ${{ secrets.pat }}
9494
ref: ${{ github.head_ref }}
95-
96-
- uses: INTI-CMNB/KiBot@v2_dk7
95+
96+
- uses: INTI-CMNB/KiBot@v2_dk8
9797
with:
9898
config: ${{ env.kibot }}/placement.kibot.yaml
9999
schema: ${{ env.schema }}
100100
board: ${{ env.board }}
101101
dir: ${{ env.dir }}_docs
102-
103-
- uses: INTI-CMNB/KiBot@v2_dk7
102+
103+
- uses: INTI-CMNB/KiBot@v2_dk8
104104
with:
105105
config: ${{ env.kibot }}/xml.kibot.yaml
106106
schema: ${{ env.schema }}
107107
board: ${{ env.board }}
108108
dir: ${{ env.dir }}_docs
109-
109+
110110
# - name: "Rename output"
111111
# run: |
112112
# for file in $(find ${{env.dir}} -type f); do sudo mv "${file}" "${file//${{env.project}}/${{env.branch}}}" ; done
@@ -118,7 +118,7 @@ jobs:
118118
mkdir doc_xml || true ;
119119
mv hw/sch_pcb/*.xml doc_xml/ || true;
120120
mv hw/out_docs/*.csv doc_xml/ || true;
121-
121+
122122
- uses: actions/upload-artifact@v3
123123
if: ${{ success() }}
124124
with:
@@ -145,14 +145,14 @@ jobs:
145145
submodules: recursive
146146
token: ${{ secrets.pat }}
147147
ref: ${{ github.head_ref }}
148-
149-
- uses: INTI-CMNB/KiBot@v2_dk7
148+
149+
- uses: INTI-CMNB/KiBot@v2_dk8
150150
with:
151151
config: ${{ env.kibot }}/report.kibot.yaml
152152
schema: ${{ env.schema }}
153153
board: ${{ env.board }}
154154
dir: ${{ env.dir }}_report
155-
155+
156156
- uses: actions/upload-artifact@v3
157157
if: ${{ success() }}
158158
with:
@@ -169,17 +169,17 @@ jobs:
169169
submodules: recursive
170170
token: ${{ secrets.pat }}
171171
ref: ${{ github.head_ref }}
172-
173-
- uses: INTI-CMNB/KiBot@v2_dk7
172+
173+
- uses: INTI-CMNB/KiBot@v2_dk8
174174
with:
175175
config: ${{ env.kibot }}/ibom.kibot.yaml
176176
schema: ${{ env.schema }}
177177
board: ${{ env.board }}
178178
dir: ${{ env.dir }}_ibom
179-
179+
180180
- name: "Rename output"
181181
run: for file in $(find ${{env.dir}} -type f); do sudo mv "${file}" "${file//${{env.project}}/${{env.branch}}}" ; done
182-
182+
183183
- uses: actions/upload-artifact@v3
184184
if: ${{ success() }}
185185
with:
@@ -198,8 +198,8 @@ jobs:
198198
submodules: recursive
199199
token: ${{ secrets.pat }}
200200
ref: ${{ github.head_ref }}
201-
202-
- uses: INTI-CMNB/KiBot@v2_dk7
201+
202+
- uses: INTI-CMNB/KiBot@v2_dk8
203203
with:
204204
config: ${{ env.kibot }}/gerbers.kibot.yaml
205205
schema: ${{ env.schema }}
@@ -209,7 +209,7 @@ jobs:
209209

210210
- name: "Rename output"
211211
run: for file in $(find ${{env.dir}}_gerbers -type f); do sudo mv "${file}" "${file//${{env.project}}/${{env.branch}}}" || true ; done
212-
212+
213213
- uses: actions/upload-artifact@v2
214214
if: ${{ success() }}
215215
with:
@@ -227,15 +227,15 @@ jobs:
227227
submodules: recursive
228228
token: ${{ secrets.pat }}
229229
ref: ${{ github.head_ref }}
230-
231-
- uses: INTI-CMNB/KiBot@v2_dk7
230+
231+
- uses: INTI-CMNB/KiBot@v2_dk8
232232
with:
233233
config: ${{ env.kibot }}/cad.kibot.yaml
234234
schema: ${{ env.schema }}
235235
board: ${{ env.board }}
236236
dir: ${{ env.dir }}_cad
237-
238-
- uses: INTI-CMNB/KiBot@v2_dk7
237+
238+
- uses: INTI-CMNB/KiBot@v2_dk8
239239
with:
240240
config: ${{ env.kibot }}/render.kibot.yaml
241241
schema: ${{ env.schema }}
@@ -248,7 +248,7 @@ jobs:
248248
with:
249249
name: doc_cad
250250
path: ${{ env.dir }}_cad/**
251-
251+
252252
- uses: actions/upload-artifact@v3
253253
if: ${{ success() }}
254254
with:
@@ -272,15 +272,15 @@ jobs:
272272
273273
- name: Download a Build Artifact
274274
uses: actions/download-artifact@v3.0.0
275-
275+
276276
- name: Remove old manufarturing data
277-
run: |
277+
run: |
278278
rm -r hw/cam_profi || true
279279
rm -r doc/gen || true
280-
280+
281281
- name: Extract to right position
282282
run: |
283-
283+
284284
mkdir doc || true
285285
mkdir doc/gen || true
286286
mkdir doc/gen/img || true
@@ -291,7 +291,7 @@ jobs:
291291
mkdir hw/cam_profi/gbr || true
292292
mkdir hw/cam_profi/assembly || true
293293
mkdir hw/cam_profi/ibom || true
294-
294+
295295
cp -r doc_img/* doc/gen/img || true
296296
cp -r doc_cad/cad/* doc/gen || true
297297
cp -r hw_cam_profi/* hw/cam_profi/gbr || true
@@ -313,9 +313,9 @@ jobs:
313313
rm -r doc_xml || true
314314
rm -r doc_report || true
315315
rm -r doc_ibom || true
316-
316+
317317
git add . -f
318-
318+
319319
- uses: stefanzweifel/git-auto-commit-action@v4.16.0
320320
with:
321321
commit_message: Update actions products

‎README.md

+47-43
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,48 @@
1-
<!--- PrjInfo ---> <!--- Please remove this line after manually editing --->
2-
<!--- 00a56be08b96043df9e37d6aff7b6990 --->
3-
<!--- Created:2019-10-10 19:35:25.196922: --->
4-
<!--- Author:: --->
5-
<!--- AuthorEmail:: --->
6-
<!--- Tags:: --->
7-
<!--- Ust:: --->
8-
<!--- Label --->
9-
<!--- ELabel --->
10-
<!--- Name:ISM02A: --->
11-
# ISM02B
12-
<!--- LongName --->
13-
##
14-
<!--- ELongName --->
1+
# ISM02 - Long Range, Low Power, sub-GHz RF Transceiver
2+
3+
ISM02A is a telemetry module based on the Semtech SX1262 RF transceiver. This module is widely used in LoRa and other sub-GHz wireless communication applications. It incorporates an RF switch (PE4259) to multiplex RX and TX on a single antenna, making it a compact solution for IoT and telemetry use cases.
4+
5+
![ISM02A Top](doc/img/ISM02B_top.png)
6+
![ISM02A Bottom](doc/img/ISM02B_bot.png)
7+
8+
9+
## Features
10+
- **RF Transceiver:** [SX1262](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
11+
- More power-efficient compared to the SX127x series
12+
- Additional features with a smaller footprint and fewer external components
13+
- Operating frequency range: 150 MHz to 960 MHz
14+
- Supports LoRa and (G)FSK modulation
15+
- Maximum output power: +22 dBm
16+
- Low power consumption: 4.2 mA in receive mode
17+
- Complies with ETSI EN 300 220, FCC CFR 47 Part 15, and other global ISM band regulations
18+
- **RF Switch:** [PE4259](https://www.psemi.com/products/rf-switches/pe4259) UltraCMOS RF switch
19+
- Frequency range: 10 MHz – 3000 MHz
20+
- Low insertion loss: 0.35 dB @ 1000 MHz
21+
- High isolation: 30 dB @ 1000 MHz
22+
- High ESD tolerance of 2 kV HBM
23+
- Used to multiplex RX and TX on a single antenna
24+
25+
The module is typically used as a LoRa device and offers flexible wireless communication for various low-power, long-range applications.
26+
27+
## Applications
28+
- Smart meters
29+
- Agricultural sensors
30+
- Asset tracking
31+
- Smart cities
32+
- Remote control applications
33+
34+
## Specifications
35+
36+
| Parameter | Value | Description |
37+
|--------------------|------------------------------|----------------------------------|
38+
| Dimensions | 50.292 x 29.972 mm | Physical size of the module |
39+
| Frequency Range | 150 MHz – 960 MHz | Supports sub-GHz ISM bands |
40+
| Modulation Types | LoRa, FSK | Supports LoRaWAN and proprietary |
41+
| Max Output Power | +22 dBm | Using SX1262 |
42+
| Power Consumption | 4.2 mA in Rx mode | Low power consumption |
43+
| RF Switch | PE4259 | Used for antenna multiplexing |
44+
45+
## Additional Resources
46+
- [SX1262 Datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
47+
- [PE4259 Datasheet](https://www.psemi.com/products/rf-switches/pe4259)
1548

16-
<!--- Lead --->
17-
18-
<!--- Description --->
19-
RF Transceiver module with [SX1262](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262). The SX1262 has several advantages to widely SX127x used alternative
20-
21-
* More power-efficient
22-
* More features
23-
* Smaller footprint
24-
* Less external components
25-
26-
The module is usually used as LoRa device. The used circuit contains RF switch to multiplex RX and TX on the single antenna.
27-
28-
<!--- ELead --->
29-
30-
| Parameter | Value | Description |
31-
|-----------|-------|-------------|
32-
|Dimensions: | 50,292 x 29,972 mm | - |
33-
34-
![ISM02B Top](doc/img/ISM02B_top.png)
35-
36-
![ISM02B Bottom](doc/img/ISM02B_bot.png)
37-
38-
39-
40-
41-
<!--- EDescription --->
42-
<!--- Content --->
43-
<!--- EContent --->
44-
<sub><sup> Generated with [MLABweb](https://github.com/MLAB-project/MLABweb). (2019-10-10)</sup></sub>

‎doc/assets

‎doc/pdf/pe4259ds.pdf

561 KB
Binary file not shown.

‎hw/sch_pcb/ISM02.kicad_prl

+7-1
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,14 @@
6969
"visible_layers": "fffffff_ffffffff",
7070
"zone_display_mode": 0
7171
},
72+
"git": {
73+
"repo_password": "",
74+
"repo_type": "",
75+
"repo_username": "",
76+
"ssh_key": ""
77+
},
7278
"meta": {
73-
"filename": "ISM02B.kicad_prl",
79+
"filename": "ISM02.kicad_prl",
7480
"version": 3
7581
},
7682
"project": {

0 commit comments

Comments
 (0)