Welcome to the Mxchip AX1366 Toolbox 🛠️, your gateway to a limitless realm of IoT and Embedded Systems projects! With this toolbox at your fingertips, you'll delve into the exciting world of device development, from crafting intricate button and LED interactions to seamlessly transmitting sensor data to your Azure Platform.
But that's just the beginning! In upcoming releases, brace yourself for a journey into connectivity mastery. Picture this: effortlessly linking your devkit to diverse platforms like the intuitive flow-based programming of Node-RED 🌐, harnessing the immense capabilities of Azure IoT Hub ☁️, or orchestrating events with lightning speed using Event Grid ⚡. All this magic unfolds through cutting-edge protocols like MQTT or the ever-reliable Wi-Fi 📶.
Join us as we transform your development experience into a thrilling adventure where innovation knows no bounds! 🌟
Current Features
- Project Scaffolding: Scaffold a new project with predefined templates 📝.
- Mxchip Example Projects: Included in this toolbox are some example projects to help interact with the Mxchip Az1366 🎓.
- Easy Driver Installation for Project: Supports downloading and extracting project templates automatically from a GitHub repository 💻.
Example Projects Available
- Button Screen RGB: Interact with buttons and LEDs and watch the OLED screen change on the MXchip 🎨.
- Button Screen Counter: By pressing the onboard buttons, initiate a count system on the dev board and display on the screen 🔢.
- Dino Game: Test the popular Dino game from Google Chrome on your favorite Mxchip devkit 🦖.
- Ping Pong Game: Play the classic Ping Pong game on your Mxchip now 🏓.
- IoT Hub Telemetry: Read sensor data from the devkit and publish it to IoT Hub 📈.
Screenshots
Requirements
For Windows Users
- For first-time users, run this command in PowerShell as an Admin:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned.
- After that, type Y and press Enter.
- Press
F1 and type and select the command Mxchip Create New MXCHIP AZ1366 Project.
- After the project has been scaffolded, open it in a new window or the current one.
- Press
F1 and type the command Mxchip Install Drivers and select it. Click yes to the prompt to install cmake.
- (Please note this step may take some time, so please grab a cup of coffee ☕ and wait).
- Once the drivers are installed, include cmake in the environmental path. See the gif below for a guide.
- Restart VSCode, then press
F1, type the command Mxchip Upload Project, and make sure your MXchip is connected to the host machine.
- Wait for the program to build and install on the devkit.
📹 Cmake Env Variables
![Watch the video]
For Linux Users
- For first-time users, press
F1 and type and select the command Mxchip Create New MXCHIP AZ1366 Project.
- After the project has been scaffolded, open it in a new window or the current one.
- Press
F1 and type the command Mxchip Install Drivers and select it. Enter your password to install cmake.
- Once the drivers are installed, restart VSCode, then press
F1, type the command Mxchip Upload Project, and make sure your MXchip is connected to the host machine.
- Wait for the program to build and install on the devkit.
Ensure the following requirements are met before using this extension:
- Visual Studio Code version 1.87.0 or higher.
- Arduino IDE.
Extension Settings
This extension contributes the following settings:
mxchip-az1366.enable: Enable/disable this extension.mxchip-az1366.templateRepoUrl: Set the URL for the GitHub repository containing the template.mxchip-az1366.MXCHIPCreateProject: Mxchip Create New MXCHIP AZ1366 Project.mxchip-az1366.MXCHIPUploadProject: Mxchip Upload Project.mxchip-az1366.MXCHIPExampleButtonScreenCounter: Mxchip Example: Button Screen Counter.mxchip-az1366.MXCHIPExampleButtonScreenRGB: Mxchip Example: Button Screen RGB.mxchip-az1366.MXCHIPExampleDinoGame: Mxchip Example: Dino Game.mxchip-az1366.MXCHIPExamplePingPongGame: Mxchip Example: Ping Pong Game.mxchip-az1366.MXCHIPInstallDrivers: Mxchip Install Drivers.
📅 Roadmap / Upcoming Features
- 🌐 Node-RED Integration: Effortlessly link your devkit to diverse platforms with Node-RED.
- ☁️ Azure Event Grid: Harness the immense capabilities of Azure Event Grid.
- ⚙️ .NET Nano Framework: Explore the capabilities of the .NET Nano Framework.
- 🔄 MQTT Support: Utilize cutting-edge MQTT protocols for seamless communication.
🚧 Known Issues
- macOS and iOS Systems Not Supported: Release for macOS and iOS will be out soon.
- Path Length Limitations(Windows): Enabling long paths in Windows can introduce potential compatibility issues with older applications or tools that do not support long paths. Additionally, certain file system tools might not handle long paths correctly, which can affect the integrity of backups or other file system operations. Long and complex paths might also make it more challenging to manage and audit user permissions, and malware or malicious users might take advantage of long paths to hide files or directories.
- Solution: To enable long paths in Windows, you can follow these steps:
- Open the
Local Group Policy Editor by typing gpedit.msc in the Run dialog (Win + R).
- Navigate to
Local Computer Policy > Computer Configuration > Administrative Templates > System > Filesystem.
- Double-click on
Enable NTFS long paths and set it to Enabled.
- Click
OK and restart your computer.
🤝 Credits
Special thanks to the original creators of the code:
For more Hands-on Demo and Projects on the Mxchip Az1366 devkit.
🛠 Contributing
We welcome contributions from the community! To contribute:
- Fork the repository on GitHub.
- Create a new branch from
main.
- Make your changes and commit them with clear messages.
- Push your changes to your forked repository.
- Create a Pull Request (PR) to the
main branch of the original repository.
Please ensure your code adheres to our coding standards and includes tests where applicable.
🐛 Issue Tracking
Found a bug or have a feature request? Please open an issue on our GitHub Issues page.
📜 License
This project is licensed under the MIT License. See the LICENSE file for details.
Enjoy! 🎉
