Skip to content

Commit

Permalink
Updating documentation and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
kaklik committed Sep 29, 2024
1 parent 2aa964c commit 0ea3f29
Show file tree
Hide file tree
Showing 8 changed files with 11,956 additions and 5,132 deletions.
80 changes: 40 additions & 40 deletions .github/workflows/kicad_outputs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
- '**.yml'
- 'doc/assets'
workflow_dispatch:

env:
schema: "hw/sch_pcb/${{ github.event.repository.name }}.kicad_sch"
board: "hw/sch_pcb/${{ github.event.repository.name }}.kicad_pcb"
Expand All @@ -32,15 +32,15 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/erc.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}


DRC:
runs-on: ubuntu-latest
continue-on-error: true
Expand All @@ -50,15 +50,15 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/drc.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}


schematics:
runs-on: ubuntu-latest
continue-on-error: true
Expand All @@ -68,8 +68,8 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/schematics.kibot.yaml
schema: ${{ env.schema }}
Expand All @@ -81,7 +81,7 @@ jobs:
with:
name: doc_sch
path: ${{ env.dir }}_docs/**

placement:
name: "Placement and XML"
runs-on: ubuntu-latest
Expand All @@ -92,21 +92,21 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/placement.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}_docs
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/xml.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}_docs

# - name: "Rename output"
# run: |
# for file in $(find ${{env.dir}} -type f); do sudo mv "${file}" "${file//${{env.project}}/${{env.branch}}}" ; done
Expand All @@ -118,7 +118,7 @@ jobs:
mkdir doc_xml || true ;
mv hw/sch_pcb/*.xml doc_xml/ || true;
mv hw/out_docs/*.csv doc_xml/ || true;
- uses: actions/upload-artifact@v3
if: ${{ success() }}
with:
Expand All @@ -145,14 +145,14 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/report.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}_report

- uses: actions/upload-artifact@v3
if: ${{ success() }}
with:
Expand All @@ -169,17 +169,17 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/ibom.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}_ibom

- name: "Rename output"
run: for file in $(find ${{env.dir}} -type f); do sudo mv "${file}" "${file//${{env.project}}/${{env.branch}}}" ; done

- uses: actions/upload-artifact@v3
if: ${{ success() }}
with:
Expand All @@ -198,8 +198,8 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/gerbers.kibot.yaml
schema: ${{ env.schema }}
Expand All @@ -209,7 +209,7 @@ jobs:

- name: "Rename output"
run: for file in $(find ${{env.dir}}_gerbers -type f); do sudo mv "${file}" "${file//${{env.project}}/${{env.branch}}}" || true ; done

- uses: actions/upload-artifact@v2
if: ${{ success() }}
with:
Expand All @@ -227,15 +227,15 @@ jobs:
submodules: recursive
token: ${{ secrets.pat }}
ref: ${{ github.head_ref }}
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/cad.kibot.yaml
schema: ${{ env.schema }}
board: ${{ env.board }}
dir: ${{ env.dir }}_cad
- uses: INTI-CMNB/KiBot@v2_dk7

- uses: INTI-CMNB/KiBot@v2_dk8
with:
config: ${{ env.kibot }}/render.kibot.yaml
schema: ${{ env.schema }}
Expand All @@ -248,7 +248,7 @@ jobs:
with:
name: doc_cad
path: ${{ env.dir }}_cad/**

- uses: actions/upload-artifact@v3
if: ${{ success() }}
with:
Expand All @@ -272,15 +272,15 @@ jobs:
- name: Download a Build Artifact
uses: actions/[email protected]

- name: Remove old manufarturing data
run: |
run: |
rm -r hw/cam_profi || true
rm -r doc/gen || true
- name: Extract to right position
run: |
mkdir doc || true
mkdir doc/gen || true
mkdir doc/gen/img || true
Expand All @@ -291,7 +291,7 @@ jobs:
mkdir hw/cam_profi/gbr || true
mkdir hw/cam_profi/assembly || true
mkdir hw/cam_profi/ibom || true
cp -r doc_img/* doc/gen/img || true
cp -r doc_cad/cad/* doc/gen || true
cp -r hw_cam_profi/* hw/cam_profi/gbr || true
Expand All @@ -313,9 +313,9 @@ jobs:
rm -r doc_xml || true
rm -r doc_report || true
rm -r doc_ibom || true
git add . -f
- uses: stefanzweifel/[email protected]
with:
commit_message: Update actions products
Expand Down
90 changes: 47 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,48 @@
<!--- PrjInfo ---> <!--- Please remove this line after manually editing --->
<!--- 00a56be08b96043df9e37d6aff7b6990 --->
<!--- Created:2019-10-10 19:35:25.196922: --->
<!--- Author:: --->
<!--- AuthorEmail:: --->
<!--- Tags:: --->
<!--- Ust:: --->
<!--- Label --->
<!--- ELabel --->
<!--- Name:ISM02A: --->
# ISM02B
<!--- LongName --->
##
<!--- ELongName --->
# ISM02 - Long Range, Low Power, sub-GHz RF Transceiver

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.

![ISM02A Top](doc/img/ISM02B_top.png)
![ISM02A Bottom](doc/img/ISM02B_bot.png)


## Features
- **RF Transceiver:** [SX1262](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- More power-efficient compared to the SX127x series
- Additional features with a smaller footprint and fewer external components
- Operating frequency range: 150 MHz to 960 MHz
- Supports LoRa and (G)FSK modulation
- Maximum output power: +22 dBm
- Low power consumption: 4.2 mA in receive mode
- Complies with ETSI EN 300 220, FCC CFR 47 Part 15, and other global ISM band regulations
- **RF Switch:** [PE4259](https://www.psemi.com/products/rf-switches/pe4259) UltraCMOS RF switch
- Frequency range: 10 MHz – 3000 MHz
- Low insertion loss: 0.35 dB @ 1000 MHz
- High isolation: 30 dB @ 1000 MHz
- High ESD tolerance of 2 kV HBM
- Used to multiplex RX and TX on a single antenna

The module is typically used as a LoRa device and offers flexible wireless communication for various low-power, long-range applications.

## Applications
- Smart meters
- Agricultural sensors
- Asset tracking
- Smart cities
- Remote control applications

## Specifications

| Parameter | Value | Description |
|--------------------|------------------------------|----------------------------------|
| Dimensions | 50.292 x 29.972 mm | Physical size of the module |
| Frequency Range | 150 MHz – 960 MHz | Supports sub-GHz ISM bands |
| Modulation Types | LoRa, FSK | Supports LoRaWAN and proprietary |
| Max Output Power | +22 dBm | Using SX1262 |
| Power Consumption | 4.2 mA in Rx mode | Low power consumption |
| RF Switch | PE4259 | Used for antenna multiplexing |

## Additional Resources
- [SX1262 Datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [PE4259 Datasheet](https://www.psemi.com/products/rf-switches/pe4259)

<!--- Lead --->

<!--- Description --->
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

* More power-efficient
* More features
* Smaller footprint
* Less external components

The module is usually used as LoRa device. The used circuit contains RF switch to multiplex RX and TX on the single antenna.

<!--- ELead --->

| Parameter | Value | Description |
|-----------|-------|-------------|
|Dimensions: | 50,292 x 29,972 mm | - |

![ISM02B Top](doc/img/ISM02B_top.png)

![ISM02B Bottom](doc/img/ISM02B_bot.png)




<!--- EDescription --->
<!--- Content --->
<!--- EContent --->
<sub><sup> Generated with [MLABweb](https://github.com/MLAB-project/MLABweb). (2019-10-10)</sup></sub>
Binary file added doc/pdf/pe4259ds.pdf
Binary file not shown.
8 changes: 7 additions & 1 deletion hw/sch_pcb/ISM02.kicad_prl
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,14 @@
"visible_layers": "fffffff_ffffffff",
"zone_display_mode": 0
},
"git": {
"repo_password": "",
"repo_type": "",
"repo_username": "",
"ssh_key": ""
},
"meta": {
"filename": "ISM02B.kicad_prl",
"filename": "ISM02.kicad_prl",
"version": 3
},
"project": {
Expand Down
Loading

0 comments on commit 0ea3f29

Please sign in to comment.