# Installing with a macOS based computer

</br>

> [!NOTE]
>
> This page describes the new installation method using the official M5Burner v3 utility.
>
> Screenshots will be added soon. Feedback and corrections are welcome, please PR or create an [issue](https://github.com/psonnera/M5_NightscoutMon/issues).

</br>

This guide explains step by step how to program your M5Stack with the official M5Stack M5Burner utility (Arduino not required).

</br>

## Check the serial port

</br>

Connect the M5Stack device to your computer with the USB cable, open a terminal (Applications > Utilities > Terminal) and enter:

```
ls /dev/cu.*
```

Recent macOS versions (Catalina 10.15 and later) recognize most M5Stack devices without installing any driver. Depending on your device you should see a new port appear such as:

- `/dev/cu.usbserial-XXXX` (CP2104 chip, built-in macOS driver)
- `/dev/cu.wchusbserial-XXXX` (CH9102 chip)
- `/dev/cu.SLAB_USBtoUART` (CP2104 chip with the SiLabs driver installed)

Take note of the port name, you will need it later.

**If a new port appears, no driver is needed: skip to [Download and install M5Burner](#download-and-install-m5burner).**

</br>

## Install the M5Stack USB driver (only if no port appeared)

</br>

- Go to the M5Stack download page https://docs.m5stack.com/en/download, section **USB Driver**, and download the driver matching your device:

  - **CH9102 chip** (most recent Basic and Core2 units): `CH9102_VCP_SER_MacOS` (take the M1 Silicon version if your Mac has an Apple Silicon processor). On macOS 13 and later you must then allow the driver in System Settings > General > Login Items & Extensions > Driver Extensions. Reconnect the device: the port appears as `/dev/cu.wchusbserial-XXXX`. The same driver is also available from the manufacturer WCH at https://github.com/WCHSoftGroup/ch34xser_macos.
  - **CP2104 chip** (older Basic and Core units): `CP210x_VCP_MacOS`.

[[/images/InstallMac01.png|M5Stack USB driver download]]
</br>

#### Alternative for the CP2104 chip

- Go to SiLabs https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers and download the macOS version.

[[/images/InstallMac02.png|SiLabs driver download]]

</br>

Allow download and open finder to Downloads, folder Mac_OSX_VCP_Driver, double click the SiLabsUSBDriverDisk.dmg. The disk will extract on your desktop. Open it and run the installer.

[[/images/InstallMac03.png|SiLabs driver disk]]

</br>

Select Open

[[/images/InstallMac04.png|Open the installer]]

</br>

Click Continue, Continue, Agree to license…

[[/images/InstallMac05b.png|Installer license]]

</br>

Continue, enter your password, Continue, Open Security Preferences

[[/images/InstallMac06.png|Security preferences]]

</br>

Unlock the panel (enter your password) and allow the driver, close Security & Privacy

[[/images/InstallMac07.png|Allow the driver]]

</br>

Wait until the install completes and close.

[[/images/InstallMac08.png|Installation complete]]

</br>

Reconnect the M5Stack device and check the port again with `ls /dev/cu.*`

</br>

## Download and install M5Burner

</br>

Go to the official M5Burner page https://docs.m5stack.com/en/uiflow/m5burner and download the **MacOS x64** version.

[[/images/M5BurnerMac01.png|M5Burner download page]]

</br>

Open the downloaded .dmg file and drag **M5Burner** to your **Applications** folder.

[[/images/M5BurnerMac02.png|Drag M5Burner to Applications]]

</br>

On the first launch, macOS may block the application because it was not downloaded from the App Store. Right click (or Control-click) on M5Burner in Applications and select **Open**, then confirm **Open**. If macOS still refuses, go to System Settings > Privacy & Security and click **Open Anyway**.

[[/images/M5BurnerMac03.png|macOS Gatekeeper warning]]

</br>

## Get the M5_NightscoutMon firmware

</br>

The firmware is published in the **USER CUSTOM** section of M5Burner and is retrieved with a share code.

1. Click **USER CUSTOM** at the bottom of the left menu.

[[/images/M5BurnerMac05.png|USER CUSTOM section]]

2. Click the **Share Burn** button at the top of the window.

3. Enter the share code **matching your device**:

| Device | Share code |
|---|---|
| M5Stack Basic / Core (grey, all models) | `0nPW6eAzC7GcnfWN` |
| M5Stack Core2 | `1HgGY5jdSokZb7JK` |

[[/images/M5BurnerMac06.png|Share Burn dialog]]

</br>

## Flash the firmware

</br>

M5Burner downloads the firmware and opens the burn window:

1. Check your M5Stack device is connected.
2. Select the serial port of your device (the one you noted before, for example `/dev/cu.usbserial-XXXX`).
3. Select baudrate **921600**.
4. Click **Start** and wait until the operation completes.

[[/images/M5BurnerMac07.png|Burn window with serial port and baudrate]]

</br>

*Troubleshooting: if the burn fails or stops, try again with a lower baudrate (115200), use a different USB cable or USB port, and make sure no other program is using the serial port.*

</br>

Congratulations, you programmed your M5Stack.

</br>

Continue with the setup [here](./Setup).

</br>

---

*Looking for the previous installation method (command line with esptool)? See the [old macOS instructions](./MacCLI).*