Skip to content

Commit 22d607d

Browse files
committed
update commit
1 parent ba4c828 commit 22d607d

223 files changed

Lines changed: 53396 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,52 @@
1-
# MiWi
1+
![Microchip logo](https://raw.githubusercontent.com/wiki/Microchip-MPLAB-Harmony/Microchip-MPLAB-Harmony.github.io/images/microchip_logo.png)
2+
![Harmony logo small](https://raw.githubusercontent.com/wiki/Microchip-MPLAB-Harmony/Microchip-MPLAB-Harmony.github.io/images/microchip_mplab_harmony_logo_small.png)
3+
4+
# MPLAB® Harmony 3 MiWi
5+
6+
MPLAB® Harmony 3 is an extension of the MPLAB® ecosystem for creating embedded firmware solutions for Microchip 32-bit SAM and PIC® microcontroller and microprocessor devices. Refer to the following links for more information.
7+
8+
- [Microchip 32-bit MCUs](https://www.microchip.com/design-centers/32-bit)
9+
- [Microchip 32-bit MPUs](https://www.microchip.com/design-centers/32-bit-mpus)
10+
- [Microchip MPLAB X IDE](https://www.microchip.com/mplab/mplab-x-ide)
11+
- [Microchip MPLAB® Harmony](https://www.microchip.com/mplab/mplab-harmony)
12+
- [Microchip MPLAB® Harmony Pages](https://microchip-mplab-harmony.github.io/)
13+
14+
This repository contains the MPLAB® Harmony 3 MiWi for PIC32CX-BZ2 platform devices.
15+
The MiWi protocol stack supports MiWi's own proprietary application(MiApp) & mac layer(MiMAC) and IEEE 802.15.4 Standalone PHY Layer of devices like WBZ451, RF233 and RF212B.
16+
Refer to the following links for release notes, training materials, and interface reference information.
17+
18+
As a first step, the [MiWi](https://github.com/MicrochipTech/MiWi) repo must be cloned to the User's Local Harmony repo folder location and follow the steps mentioned in the follwoing [link](https://github.com/MicrochipTech/MiWi/blob/main/docs/GUID-32628D58-8B41-490F-8DA4-520C34856980.md) to generate the harmony project application.
19+
User must have atleast a Standalone PHY component that supports [WBZ451](https://github.com/Microchip-MPLAB-Harmony/wireless_15_4_phy) or Standalone Transceivers like [RF233](https://github.com/MicrochipTech/wireless_15_4_phy_trx) / [RF212B]( https://github.com/MicrochipTech/wireless_15_4_phy_trx ).
20+
21+
- [Release Notes](./release_notes.md)
22+
- [MPLAB® Harmony License](mplab_harmony_license.md)
23+
- [MPLAB® Harmony 3 MiWi API Help](docs/index.md)
24+
25+
# Contents Summary
26+
27+
| Folder | Description |
28+
| -----------| ------------------------------------------------------------------|
29+
| config | MiWi module configuration file |
30+
| docs| [MiWi User Guide documentation](docs/index.md)|
31+
| drivers | MiWi Protocol files and dependent files for pic32cxbz2 products |
32+
33+
34+
____
35+
36+
[![License](https://img.shields.io/badge/license-Harmony%20license-orange.svg)](https://github.com/Microchip-MPLAB-Harmony/replaceme/blob/master/mplab_harmony_license.md)
37+
[![Latest release](https://img.shields.io/github/release/Microchip-MPLAB-Harmony/replaceme.svg)](https://github.com/Microchip-MPLAB-Harmony/replaceme/releases/latest)
38+
[![Latest release date](https://img.shields.io/github/release-date/Microchip-MPLAB-Harmony/replaceme.svg)](https://github.com/Microchip-MPLAB-Harmony/replaceme/releases/latest)
39+
[![Commit activity](https://img.shields.io/github/commit-activity/y/Microchip-MPLAB-Harmony/replaceme.svg)](https://github.com/Microchip-MPLAB-Harmony/replaceme/graphs/commit-activity)
40+
[![Contributors](https://img.shields.io/github/contributors-anon/Microchip-MPLAB-Harmony/replaceme.svg)]()
41+
42+
____
43+
44+
[![Follow us on Youtube](https://img.shields.io/badge/Youtube-Follow%20us%20on%20Youtube-red.svg)](https://www.youtube.com/user/MicrochipTechnology)
45+
[![Follow us on LinkedIn](https://img.shields.io/badge/LinkedIn-Follow%20us%20on%20LinkedIn-blue.svg)](https://www.linkedin.com/company/microchip-technology)
46+
[![Follow us on Facebook](https://img.shields.io/badge/Facebook-Follow%20us%20on%20Facebook-blue.svg)](https://www.facebook.com/microchiptechnology/)
47+
[![Follow us on Twitter](https://img.shields.io/twitter/follow/MicrochipTech.svg?style=social)](https://twitter.com/MicrochipTech)
48+
49+
[![](https://img.shields.io/github/stars/Microchip-MPLAB-Harmony/replaceme.svg?style=social)]()
50+
[![](https://img.shields.io/github/watchers/Microchip-MPLAB-Harmony/replaceme.svg?style=social)]()
51+
52+

config/module.py

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# coding: utf-8
2+
##############################################################################
3+
# Copyright (C) 2023 Microchip Technology Inc. and its subsidiaries.
4+
#
5+
# Subject to your compliance with these terms, you may use Microchip software
6+
# and any derivatives exclusively with Microchip products. It is your
7+
# responsibility to comply with third party license terms applicable to your
8+
# use of third party software (including open source software) that may
9+
# accompany Microchip software.
10+
#
11+
# THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
12+
# EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
13+
# WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
14+
# PARTICULAR PURPOSE.
15+
#
16+
# IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
17+
# INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
18+
# WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
19+
# BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
20+
# FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
21+
# ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
22+
# THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
23+
##############################################################################
24+
def loadModule():
25+
print('Load Module: Harmony Wireless MiWi (Applications and Protocol Libraries)')
26+
27+
pic32cx_bz2_family = {'PIC32CX1012BZ25048',
28+
'PIC32CX1012BZ25032',
29+
'PIC32CX1012BZ24032',
30+
'WBZ451',
31+
'WBZ450',
32+
'ATSAML21J18B',
33+
'ATSAMR21G18A',
34+
'ATSAMD20J18A',
35+
'ATSAMD21J18A',
36+
'WBZ351',
37+
}
38+
39+
processor = Variables.get('__PROCESSOR')
40+
41+
print('processor={}'.format(processor))
42+
43+
if (processor in pic32cx_bz2_family):
44+
# MiWi Protocol Type
45+
miwicomp = Module.CreateComponent('microchipwireless', 'MiWi', 'Wireless/Drivers/', 'driver/config/drv_miwi.py')
46+
miwicomp.setDisplayType('MiWi Protocol Stack')
47+
miwicomp.addDependency('ieee802154phyDependency', 'IEEE 802.15.4 PHY', 'IEEE 802.15.4 PHY', True, True)
48+
miwicomp.addDependency('HarmonyCoreDependency', 'Core Service', 'Core', True, True)
49+
miwicomp.addDependency('SysTimeDependency', 'SYS_TIME', 'SYS_TIME', True, True)
50+
miwicomp.addDependency('FreeRtosDependency', 'RTOS', 'RTOS', True, True)
51+
miwicomp.addDependency('DeviceSupportDependency', 'Device_Support', 'Device_Support', True, True)
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Worldwide Sales and Service
2+
3+
|AMERICAS|ASIA/PACIFIC|ASIA/PACIFIC|EUROPE|
4+
|--------|------------|------------|------|
5+
|<br /> Corporate Office<br /> 2355 West Chandler Blvd.<br /> Chandler, AZ 85224-6199<br /> Tel: 480-792-7200<br /> Fax: 480-792-7277<br /> Technical Support:<br /> <br /> Web Address:<br /> <br /> Atlanta<br /> Duluth, GA<br /> Tel: 678-957-9614<br /> Fax: 678-957-1455<br /> Austin, TX<br /> Tel: 512-257-3370<br /> Boston<br /> Westborough, MA<br /> Tel: 774-760-0087<br /> Fax: 774-760-0088<br /> Chicago<br /> Itasca, IL<br /> Tel: 630-285-0071<br /> Fax: 630-285-0075<br /> Dallas<br /> Addison, TX<br /> Tel: 972-818-7423<br /> Fax: 972-818-2924<br /> Detroit<br /> Novi, MI<br /> Tel: 248-848-4000<br /> Houston, TX<br /> Tel: 281-894-5983<br /> Indianapolis<br /> Noblesville, IN<br /> Tel: 317-773-8323<br /> Fax: 317-773-5453<br /> Tel: 317-536-2380<br /> Los Angeles<br /> Mission Viejo, CA<br /> Tel: 949-462-9523<br /> Fax: 949-462-9608<br /> Tel: 951-273-7800<br /> Raleigh, NC<br /> Tel: 919-844-7510<br /> New York, NY<br /> Tel: 631-435-6000<br /> San Jose, CA<br /> Tel: 408-735-9110<br /> Tel: 408-436-4270<br /> Canada - Toronto<br /> Tel: 905-695-1980<br /> Fax: 905-695-2078<br />|<br /> Australia - Sydney<br /> Tel: 61-2-9868-6733<br /> China - Beijing<br /> Tel: 86-10-8569-7000<br /> China - Chengdu<br /> Tel: 86-28-8665-5511<br /> China - Chongqing<br /> Tel: 86-23-8980-9588<br /> China - Dongguan<br /> Tel: 86-769-8702-9880<br /> China - Guangzhou<br /> Tel: 86-20-8755-8029<br /> China - Hangzhou<br /> Tel: 86-571-8792-8115<br /> China - Hong Kong SAR<br /> Tel: 852-2943-5100<br /> China - Nanjing<br /> Tel: 86-25-8473-2460<br /> China - Qingdao<br /> Tel: 86-532-8502-7355<br /> China - Shanghai<br /> Tel: 86-21-3326-8000<br /> China - Shenyang<br /> Tel: 86-24-2334-2829<br /> China - Shenzhen<br /> Tel: 86-755-8864-2200<br /> China - Suzhou<br /> Tel: 86-186-6233-1526<br /> China - Wuhan<br /> Tel: 86-27-5980-5300<br /> China - Xian<br /> Tel: 86-29-8833-7252<br /> China - Xiamen<br /> Tel: 86-592-2388138<br /> China - Zhuhai<br /> Tel: 86-756-3210040<br />|<br /> India - Bangalore<br /> Tel: 91-80-3090-4444<br /> India - New Delhi<br /> Tel: 91-11-4160-8631<br /> India - Pune<br /> Tel: 91-20-4121-0141<br /> Japan - Osaka<br /> Tel: 81-6-6152-7160<br /> Japan - Tokyo<br /> Tel: 81-3-6880- 3770<br /> Korea - Daegu<br /> Tel: 82-53-744-4301<br /> Korea - Seoul<br /> Tel: 82-2-554-7200<br /> Malaysia - Kuala Lumpur<br /> Tel: 60-3-7651-7906<br /> Malaysia - Penang<br /> Tel: 60-4-227-8870<br /> Philippines - Manila<br /> Tel: 63-2-634-9065<br /> Singapore<br /> Tel: 65-6334-8870<br /> Taiwan - Hsin Chu<br /> Tel: 886-3-577-8366<br /> Taiwan - Kaohsiung<br /> Tel: 886-7-213-7830<br /> Taiwan - Taipei<br /> Tel: 886-2-2508-8600<br /> Thailand - Bangkok<br /> Tel: 66-2-694-1351<br /> Vietnam - Ho Chi Minh<br /> Tel: 84-28-5448-2100<br />|<br /> Austria - Wels<br /> Tel: 43-7242-2244-39<br /> Fax: 43-7242-2244-393<br /> Denmark - Copenhagen<br /> Tel: 45-4485-5910<br /> Fax: 45-4485-2829<br /> Finland - Espoo<br /> Tel: 358-9-4520-820<br /> France - Paris<br /> Tel: 33-1-69-53-63-20<br /> Fax: 33-1-69-30-90-79<br /> Germany - Garching<br /> Tel: 49-8931-9700<br /> Germany - Haan<br /> Tel: 49-2129-3766400<br /> Germany - Heilbronn<br /> Tel: 49-7131-72400<br /> Germany - Karlsruhe<br /> Tel: 49-721-625370<br /> Germany - Munich<br /> Tel: 49-89-627-144-0<br /> Fax: 49-89-627-144-44<br /> Germany - Rosenheim<br /> Tel: 49-8031-354-560<br /> Israel - Ra’anana<br /> Tel: 972-9-744-7705<br /> Italy - Milan<br /> Tel: 39-0331-742611<br /> Fax: 39-0331-466781<br /> Italy - Padova<br /> Tel: 39-049-7625286<br /> Netherlands - Drunen<br /> Tel: 31-416-690399<br /> Fax: 31-416-690340<br /> Norway - Trondheim<br /> Tel: 47-72884388<br /> Poland - Warsaw<br /> Tel: 48-22-3325737<br /> Romania - Bucharest<br /> Tel: 40-21-407-87-50<br /> Spain - Madrid<br /> Tel: 34-91-708-08-90<br /> Fax: 34-91-708-08-91<br /> Sweden - Gothenberg<br /> Tel: 46-31-704-60-40<br /> Sweden - Stockholm<br /> Tel: 46-8-5090-4654<br /> UK - Wokingham<br /> Tel: 44-118-921-5800<br /> Fax: 44-118-921-5820<br />|
6+
7+
**Parent topic:**[Microchip Information](GUID-0FB3F908-88EE-45CE-94F5-E97AF9049C9B.md)
8+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Quality Management System
2+
3+
For information regarding Microchip’s Quality Management Systems, please<br /> visit [http://www.microchip.com/quality](http://www.microchip.com/quality).
4+
5+
**Parent topic:**[Microchip Information](GUID-0FB3F908-88EE-45CE-94F5-E97AF9049C9B.md)
6+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Hardware Environment Setup
2+
3+
- **[Supported Platforms and Boards](GUID-66C18385-5623-44F3-87C6-2C5B8443D8C9.md)**
4+
5+
10 KB
Loading
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Overview
2+
3+
The MiWi Development Environment \(MiWi DE\) was developed by Microchip to<br /> support a wide range of wireless applications. The backbone of MiWi DE is MiMAC and<br /> MiApp interfaces, which links the support of multiple RF transceivers and wireless<br /> communication protocols together as a well-defined, simple but robust Microchip<br /> proprietary wireless development environment.
4+
5+
Within MiWi DE, application developers can switch between RF transceivers and<br /> wireless protocols with little or no modification in the application layer. Such<br /> migration capability in MiWi DE reduces the firmware development risk to a very minimum<br /> level. MiWi DE is defined by three layers:
6+
7+
- Application layer
8+
- Protocol layer
9+
- RF transceiver layer
10+
11+
The three layers are linked together by MiMAC and MiApp interfaces. The<br /> Application layer uses MiApp interfaces to communicate to the protocol layer. In the<br /> protocol layer, there are implementations of MiWi P2P, MiWi Star, and MiWi Mesh wireless<br /> communication protocols. The drivers for Microchip RF transceivers \(AT86RF233,<br /> AT86RF212B\) are called by protocol layers via MiMAC interfaces. Configuration files are<br /> also presented in each layer.
12+
13+
![](GUID-0EC3A9CB-6C32-4601-86E8-DD6432C9AF16-low.png "MiWi™ Software")
14+
15+
The MiWi stack offers a significantly smaller footprint relative to the open<br /> standard based ZigBee® compliant protocol stack. This enables operation in<br /> microcontrollers with smaller memory/lower cost.
16+
17+
- MiWi P2P/Star – Simple Peer-to-Peer or Star network requiring minimal code size.
18+
- MiWi Mesh – A True Routing Mesh network topology. This can be used for a department store HVAC, alarm application or a large smart home application.
19+
20+
- **[MiWi v6.4 Release Content](GUID-EC52C689-45BD-416A-A137-430F17C2488C.md)**
21+
22+
- **[Supported Hardware Platforms and IDEs](GUID-CA84E0B8-5D7B-4737-BA69-F2CE8DB0D890.md)**
23+
24+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Microchip Information
2+
3+
- **[The Microchip Website](GUID-7551DC67-D79D-4F0C-B56F-7B17E12400E0.md)**
4+
5+
- **[Product Change Notification Service](GUID-CDA512D8-0DE4-4672-8716-04CAC681CB38.md)**
6+
7+
- **[Customer Support](GUID-F05182E4-B102-4775-A746-1FF37F465312.md)**
8+
9+
- **[Microchip Devices Code Protection Feature](GUID-E8251634-7B15-4073-A103-5A5F128B8699.md)**
10+
11+
- **[Legal Notice](GUID-125F1A93-76CC-4BD7-BACA-01844FBD5F4F.md)**
12+
13+
- **[Trademarks](GUID-21750586-F9F2-4E33-87FB-8F2994BF4744.md)**
14+
15+
- **[Quality Management System](GUID-07985EED-D525-413B-AEFE-78B563328687.md)**
16+
17+
- **[Worldwide Sales and Service](GUID-02A694CF-88A5-4ADA-8785-7EEEC62D66EA.md)**
18+
19+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# MiApp\_EstablishConnection
2+
3+
|API|uint8\_t MiApp\_EstablishConnection\(uint8\_t Channel, uint8\_t addr\_len,uint8\_t \*addr, uint8\_t Capability\_info, connectionConf\_callback\_t ConfCallback\)|
4+
|Description|This is the primary user interface function for the application layer to start communication with an existing PAN. For P2P protocol, this function call can establish one or more connections. For network protocol, this function can be used to join the network, or establish a virtual socket connection with a node out of the radio range.|
5+
|Pre-Condition|Protocol initialization is done. If only to establish connection with a predefined device, an active scan must be performed before and valid active scan result must be saved.|
6+
|Parameters|• uint8\_t channel – selected channel to invoke join procedure.• uint8\_t addr\_len – address length• uint8\_t \*addr – address of the parent• uint8\_t Capability\_info – capability information of the device• connectionConf\_callback\_t ConfCallback – callback routine which will be called upon the initiated connection procedure is performed|
7+
|Returns|The index of the peer device on the connection table.|
8+
|Example|<code\>// Establish one or more connections with any devicePeerIndex = MiApp\_EstablishConnection\(14, 8, 0x12345678901234567,0x80,callback\);</code\>|
9+
|Remarks|If more than one connections is established through this function call, the return value points to the index of one of the peer devices.|
10+
11+
**Parent topic:**[MiApp API Description](GUID-A47B6424-A497-498C-8B1E-044F12F201A6.md)
12+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Legal Notice
2+
3+
Information contained in this publication is provided for the sole<br /> purpose of designing with and using Microchip products.<br /> Information regarding device applications and the like is<br /> provided only for your convenience and may be superseded by<br /> updates. It is your responsibility to ensure that your<br /> application meets with your specifications.
4+
5+
THIS INFORMATION IS PROVIDED BY MICROCHIP “AS IS�. MICROCHIP MAKES NO<br /> REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR<br /> IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE<br /> INFORMATION INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES<br /> OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A<br /> PARTICULAR PURPOSE OR WARRANTIES RELATED TO ITS CONDITION,<br /> QUALITY, OR PERFORMANCE.
6+
7+
IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,<br /> INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY<br /> KIND WHATSOEVER RELATED TO THE INFORMATION OR ITS USE, HOWEVER<br /> CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR<br /> THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY<br /> LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY<br /> RELATED TO THE INFORMATION OR ITS USE WILL NOT EXCEED THE AMOUNT<br /> OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR<br /> THE INFORMATION. Use of Microchip devices in life support and/or<br /> safety applications is entirely at the buyer’s risk, and the<br /> buyer agrees to defend, indemnify and hold harmless Microchip<br /> from any and all damages, claims, suits, or expenses resulting<br /> from such use. No licenses are conveyed, implicitly or<br /> otherwise, under any Microchip intellectual property rights<br /> unless otherwise stated.
8+
9+
**Parent topic:**[Microchip Information](GUID-0FB3F908-88EE-45CE-94F5-E97AF9049C9B.md)
10+

0 commit comments

Comments
 (0)