Skip to main content

User Guide - MacCheck Diagnostic and Restore

Documentation for MacCheck Diagnostic and Restore

Updated over 4 months ago

MacCheck will be completed in a series of 5 steps (The USB Cloner process is only done once per external USB Drive)

  1. USB Cloner Process - Performing Diagnostics will require a formatted external USB Drive to be connected to the Mac you wish to diagnose.

  2. Boot Mac from External Drive - Once the external USB drive is connected, the user must boot into the computer using the external drive.

  3. MacCheck Diagnostic and Restore - Once the computer is booted using an external drive, This will present the user with the MacCheck Diagnostic application

  4. Mac Diagnostic Portal - This portal allows you to view up to 50 ports/connections at once

  5. MacCheck Cloud Database View - Once the user completes Diagnostic and Restore, results will be saved onto your Dashboard -> Mac Portal.


API Documentation

GET mac-all-device-info from Mac Device Info: https://phonecheck.atlassian.net/wiki/spaces/KB/pages/3116040194

GET mac-device-info from Mac Device Info:


System Specs

Hardware Requirement

  • Intel Based

    • USB 3.0 drive 64GB (SSD Recommended)

  • M-Series

    • USB 3.0 drive 64GB (SSD Recommended - 128 GB)

macOS-Silicon (M-series) Ventura, Sonoma, and Big Sur can technically be installed on a 64 GB USB drive,

it is not recommended for long-term use due to potential performance issues.

  • Close the Phonecheck Mac Diagnostics app.

  • Connect the MacBook to your Wi-Fi and save.

  • Reopen the Phonecheck Mac Diagnostics app.

Supported Devices

Intel-based MacBooks

  • Minimum Model Year Requirement:

    • Capable of supporting macOS Catalina.

Intel-based iMacs

  • Minimum Model Year Requirement:

    • Capable of supporting macOS Catalina.

Apple Silicon Chip MacBooks

  • Minimum Model Year Requirement:

    • Capable of supporting macOS Ventura

Support macOS

Intel-based MacBooks/iMacs/Mac mini

  • macOS Catalina

  • macOS Ventura (2016 or latest)

  • macOS Sonoma (MacBook 2018 to latest)

Apple Silicon Chip MacBooks/iMacs/Mac mini

  • macOS Ventura

  • macOS Sonoma

  • macOS Sequoia

  • macOS Big Sur (MacBook M1)

  • macOS Monterey (Mac Mini M1)

Remote Portal for Viewing

Device Information DB

Printer Support

  • Dymo Printer

  • Zebra Printer

Label Support

  • Dymo 2x4 Label

  • Zebra 4x2 Label

Non-Supported Devices

  • MacBook Model Year Lower 2012

  • Mac mini

  • Mac Studio

  • Mac Pro



Getting Started

1

Peripherals and Hardware needed to get started with Mac Diagnostics

  • MacBook to be tested

  • USB 3.0 drive 64GB (SSD Recommended)

  • Internet connection (USB to Ethernet Adapter Recommended)

2

Login with a Station User for the Bootable USB OS

  • To initiate the Mac Diagnostics testing process, begin by creating a station user.

  • Contact support if you don’t have a station user to login.

  • This user will serve as the designated account for conducting diagnostics on MacBooks.

  • If the tester already has the Phonecheck station user then he can use the same user for testing.

3

Create Bootable OS with Mac Diagnostics Application using the Phonecheck USB Cloner

  • Next, open the PhoneCheck Cloner application on the centralized station to burn the USB.

  • This USB will contain the necessary OS and the Mac Diagnostics Application for testing.

  • Move on to this section for detailed instructions on the usage of PhoneCheck Cloner.

4

Connect the MacBook to an Internet Connection

  • Connect Ethernet cable to the MacBook or the USB to Ethernet Adapter.

Note - If you don’t have ethernet and have to connect using WiFi than you need to do the following:

  • Close the Phonecheck Mac Diagnostics app.

  • Connect the Macbook to your WiFi and save.

  • Reopen the Phonecheck Mac Diagnostics app

5

Boot the MacBook from the Bootable OS created from the USB Cloner

  • Password for the Catalina & Ventura OS: 1234

  • After creating the USB, take it to the testing MacBook and open the OS from the external drive.

  • If the Mac is T2 locked and the user encounters difficulties booting the OS from the external drive, follow the provided instructions.

6

Perform Testing with the Mac Diagnostics Application

  • Once the user successfully loads the Mac Diagnostics Application, they can proceed with the testing process.

  • Detailed instructions and information about the testing procedures can be found in the provided documentation.

7

View Connected MacBooks on the Mac Portal

  • All the connected MacBooks of the same master will be displayed on the Mac portal.

  • This portal, accessible at Mac Diagnostics provides an overview of the MacBooks undergoing diagnostics.

  • Move on to this section for the detailed instructions about the Mac Portal

8

Sync Data to the Cloud Dashboard

  • The data collected during testing will be synced to the cloud dashboard, available at Phonecheck Cloud

  • This centralized dashboard offers a comprehensive view of diagnostic results and status.

  • Move on to this section for the detailed instructions about the Cloud DB



USB Cloner Process

Prerequisites

Before using the Phoncheck USB Cloner, ensure the following:

  • Connect the USB drive to your computer. more than 64 GB (Recommended SSD)

  • Obtain the port number for the USB drive.

  • Have the correct username and password for authentication.

USB Format Requirements

  • Phoncheck USB Cloner requires the USB hard drive to be formatted in the APFS (Apple File System) format. If the USB drive is not detected in PhoneCheck USB Cloner, follow the instructions below to ensure it is formatted correctly.

Download Cloner

Erasing the USB Drive to Prepare for the Phonecheck USB Cloner

Instructions:

Erase the USB Drive via DiskUtil

1

Open Disk Utility on your macOS computer.

2

Select the USB drive from the left sidebar.

3

Go to the "Erase" tab

4

Choose "APFS" from the "Format" dropdown menu.

5

Click the "Erase" button to format the USB drive in APFS

Note - Contact Support if you encounter any issues erasing in APFS format.

MacCheck USB Cloner Process

Instructions:

1

Connect the external USB drive to your computer.

2

Launch PhoneCheck USB Cloner. If already launched before the drive erasure, re-launch the Phonecheck USB Cloner.

3

Provide the required username and password. (Station User Name and Password - Contact Support if needed)

4

Select the OS

5

Select the Destination Drive.

6

Provide the port number on which you want to see the data for that Mac on the Mac Diagnostic Portal.

7

Press the "Start" button to initiate the OS cloning process.

8

Once completed, you will see "Done, installation successful."

9

External Drive can now be ejected and is ready to be used.



Boot Mac from the External Drive

Instructions:

1

Connect the External Hard Drive:

  • Ensure the external hard drive with the bootable OS is connected to your Mac.

2

Restart Your Mac:

  • Click on the Apple logo in the top left corner of the screen.

  • Select "Restart."

3

Access Boot Menu or Startup Manager:

  • For Intel-based MacBooks, Immediately press and hold the Option key on your keyboard after you hear the startup chime.

  • For Apple Silicon Chip-based MacBooks, immediately press and hold the power button on your keyboard after you hear the startup chime.

4

Select the External Hard Drive:

  • You should see a list of available bootable devices. Use the arrow keys to select the external hard drive, then press Enter to boot from it.

    (ALWAYS BOOT FROM THE EXTERNAL DRIVE)

    (DO NOT BOOT FROM THE INTERNAL DRIVE)

Mac T2 Chip Process

Operating T2 Chip Intel Mac

T2-locked Intel Macs will not allow you to boot from the external drive; to do so, follow the T2 Unlock instructions:

User Guide: https://support.phonecheck.com/en/articles/10416336-operating-t2-chip-macbook

Video: https://drive.google.com/file/d/1Gpgm2aFVyzETpTBxX0ERyJeB5OSvpxrL/view?usp=sharing



MacBook Diagnostics Application

Note - Before opening the MacBook Diagnostics Application, ensure the device is connected to the Internet.

Here’s what will happen if the Internet disconnects while using the app:

  1. If the MacCheck app is running and loses its Internet connection, a popup message will appear saying, "No Internet Connection for MacDiag app."

  2. This popup will appear anytime the app tries to:

    • Sync data to the cloud, or

    • Fetch data from the cloud but can’t because there’s no Internet.

  3. The MacCheck app will keep checking for an Internet connection in the background.

  4. As soon as the Internet is restored, the popup will automatically disappear, and the app will continue working as normal.

​​

Features & Tests

1

Begin Testing

A loading screen will appear.


This loading screen shows that the logging process has started in the background.


Once the process is complete, the user can perform diagnostics shortly after.


2

Group Selecting

When in full production, if the customer requires more than 51 available ports or if they have multiple warehouses, they will need to view their operations separately from other warehouses using Groups

Flow from the Cloud:

  • The proposed solution will require changes to the portal and diagnostic app.

  • We’ll be adding a “Grouping by Warehouse” option for users to configure via the General settings of the portal.

  • Once the group options are set, the user will select the group from the MacBook Portal main page via dropdown.

  • The user of the desktop app will select a group to send device data to that group view in the portal.

  • When viewing the Portal by group the user will only see connected devices that match the same group.

  • Cover User permissions by warehouse

  • Cover Transaction History by warehouse/group

MacDiag App Flow:

  • MacDiag app will call the Settings API to get the list of Groups.

  • If Groups are available, we would show a Drop Down on the App with all Groups.

  • Users must select 1 Group before proceeding with the MacDiag app to start testing.

  • The selected group will be saved in the app config file

  • If the user has a saved group the saved group will be shown but the user can change it.

2

Information Collection

  • Model Name

  • Serial Number

  • Chip (Processor)

  • GPU

  • CPU Temperature

  • GPU Temperature

  • macOS version

  • Battery health

  • Battery Cycle Count

  • Processor

  • Memory

  • Storage

  • iCloud

  • MDM

  • Vendor Name

  • Invoice No

  • Grade

3

Automated Tests

  • Storage

  • Memory

  • CPU

  • GPU

  • WiFi

  • Bluetooth

  • Touch ID (for Apple Silicon Chips MacBook M1 & M2)

4

Semi-Automated Tests

  • Speaker & Microphone

  • Trackpad

  • Keyboard

    • Touch ID

  • Ports

    • USB-C

    • USB-A

    • MagSafe

    • Headset

    • HDMI

    • Thunderbolt

    • SD Card

5

Manual Tests

  • Webcam

  • Display

    • LCD

    • Glass Condition

6

Grading

  • Custom Grade (A, B, C, D, etc.)

  • Shopfloor Grade (Grading questions & routing)

  • The Grade Test will now appear at the end of the test list. This means:

    1. The user will first complete all other tests—including the Cosmetic Inspection.

    2. Once all tests are done, the Grade Test will be shown at the end.

    3. The user can then assign a final grade based on the results of all the completed diagnostic tests and inspections.

    This ensures the grading is done after fully evaluating the device.

Phonecheck Diagnostics Test Flow and macOS Restore

Note - The Mac Diagnostics Desktop Application will automatically restore the OS once the user is logged into the Phonecheck Mac Diagnostics app.

Diagnostics and Restore for Mac Diagnostics Application

Test Result Status

  1. Display of Test Results

    • After completing all the tests, the user is presented with the test result screen.

Restore Status

  • The test result screen indicates one of the following restore statuses:

    • Restore Failed

      • Users can attempt a retry for a successful restore.

Erasing in Progress

  • Users can wait until the restoration process is completed.

Restore Success

  • Users can safely close the application.

Post-Testing Steps

  • Power off the Mac.

  • Remove the USB drive.



Mac Diagnostic Portal

The Mac Diagnostic Portal is a dynamic cloud-based platform that provides real-time insights into MacBook processing details. The users can effortlessly track essential information, such as the connected port, specific MacBook details, print labels, and comprehensive test results, including the number of tests passed, failed, and pending.

1

Getting Started

  • Before entering the MAC Portal, we need to log in by accessing this URL: Mac Diagnostics

2

Login

  • For Login, please use Phonecheck Master or Submaster credentials

3

Bootup MacBooks with Diagnostics

  • When the users boot up MacBooks with Phonecheck’s custom OS with the Diagnostics app, the devices will begin to show up in the portal under the ports tied to the USB drives plugged into the computers.

4

Portal Details

This portal offers testers an immediate and live overview of the MacBook's status, ensuring efficient monitoring and management of testing processes like

  • Ready / testing

  • Erasing

  • Erasing success

  • Erasing fail

  • Diagnostics pass

  • Diagnostics fail

  • Erase success and diagnostics pass

  • Erase success diagnostics fail

  • Erase fail and diagnostics pass

  • Erase fail diagnostics fail

  • Erasing and diagnostics pass

  • Erasing and diagnostics fail

  • Empty Port

5

Port Number

  • The port number will show which port number the Macbook is attached and processing.

  • The port number will be in the top left corner of the device details model.

6

Device information

Device Information will be shown on the left side of the Device Detail Model below the Port Number and will consist of the following in the same order.

  • MacBook full name

  • MacBook Chip information (Processor)

  • MacBook Memory information

  • MacBook Serial number

  • MacBook macOS information

  • MacBook Battery Health

  • MacBook Grade

7

Test Results and Statuses

This section will be identical to the Device information section in the device detail model. It will consist of the test name with a symbol showing the test status.

  • (Checkmark) Webcam: Passed

  • (X) Keyboard: Failed

  • (Circle) Speaker & Microphone: Pending

8

Eraser Information

  • This section will be shown below the Device Information section in the device detail model, consisting of the erasing information.


9

Settings

  • The Settings page is for Mac Portal customizations.

  • The Settings page consists of two tabs

    • General

    • Printers

10

General Tab

  • The General Tab consists of General Settings, which currently consists of

    • Edit Grading Option

      • from there, we can add a new custom-grade

      • we can set any grade to the default grade

    • MDM Settings

      • There is an MDM checkbox.

      • If the check box is selected, the ‘Apple Mac MDM check’ status and return status will be checked.

      • If the 'Apple Mac MDM check' status is checked, then 1 MDM License will consumed.

    • iCloud Settings

      • There is an iCloud checkbox.

      • If the check box is selected, ‘Apple Mac iCloud Lock Check’ will be checked, and the ‘Find my Mac’ status will be returned.

      • If the ‘Apple Mac iCloud Lock Check’ status will be checked, then 1 iCloud License will consumed.

11

Printers Tab

  • The 'Printers Tab' consists of the Printers Setting

  • Printers settings consist of two section

  • Choose Compatible Printer Manufacturer
    It is a drop-down menu from which we can select our printer (e.g., Dymo Printer or Zebra Printer)

  • Automatic Label Printing

    • This section consists of three options.

  • Manual Printing

    • This option will only print the label when we hit the print button on the Mac Portal's home page.

  • Print on Power Off/Disconnect

    • This option will print labels when any connected port is powered off or disconnected and testing is complete.

  • Print After Data Erase

    • This option will print labels when any Macbook is erased, and testing of MacBook is complete.


Action Buttons

1

Available Options

Every attached device with ports will show the action button when the mouse hovers on the port; the action buttons are:

  • Print button

  • Info button

2

Print Button

  • Labels for MacBooks, complete with their details, can be effortlessly printed by either selecting the print button or accessing the device detail model.

  • To print from the device detail model, click the 'i' button and then select the print option.

  • It is essential to ensure that the Dymo printer is properly connected to the system for seamless printing.

3

Info Button

  • The “i” button opens the device detail model by clicking on it.

Printing and Labeling

1

Supported Printer & Label Size

  • Dymo printer

    • Dymo 4x2 label

  • Zebra ZTC GK420t

    • Zebra 4x2 label

2

Installation of Dymo Printer driver

3

Installation of Zebra printer driver

Drivers needed to be installed

After installing these SDKs and connecting the Zebra printer, we have to manually add the connected Zebra printer to the Zebra browser SDK settings.

  • Zebra understands ZPL (Zebra programming language) syntax when printing the labels. We have to convert our label data into ZPL and then provide that to the zebra printer

  • Specifications

    Browser Print supports the following Zebra printers:

    • QLn series

    • ZT200™ series

    • ZT400™ series

    • ZT510

    • ZT600 Series

    • ZD500™ series

    • ZD400™ series

    • LP2824+

    • GK420

    • GX420

4

The following elements are available on the label:

  • Serial number and serial number barcode

  • Model

  • Wipe Status

  • Battery Health

  • Grade

  • Location No.

  • Operator

  • Functionality

  • Keyboard

  • Color

  • Storage

  • Finish Date/Time



MacCheck Cloud DB View

The Mac Devices is a view where processed MacBook records are stored for the user to view.

1

Getting Started

2

Login

  • To Log in, please use PhoneCheck Master credentials, then click on the Mac Devices tab from the sidebar.

3

Mac Devices

  • Mac Devices DB View page will consist of global filters at the top of the page right below the nav bar and columns/rows vise data showing section.

4

Data View & Column Search

  • The data Table will show the processed MacBook data in the form of table rows/columns, and the column header will consist of a search bar that will search the column.

5

Date Filter

  • The date filter provides a convenient way to display data based on different time frames, including Today, Yesterday, Last 7 days, Last 30 days, This Month, and Last Month.

  • Users can also select a Custom Date Range using the date dropdown, allowing flexibility in specifying a particular timeframe.

  • Once a timeframe is chosen from the dropdown, the relevant data is presented accordingly.

6

Using Date Range

  • Activate the Enter a date range filter by navigating to the Date Filter dropdown.

  • To access this feature, click on the dropdown and scroll to the end, where you'll find the option for Custom Date Range.

  • Once selected, the Enter a date range filter becomes enabled.

  • Click on it to open the calendar, allowing you to choose a specific date or date range.

  • The data will then be automatically adjusted and displayed based on the applied filter.

7

Search Devices filter

  • Utilize the search filter on the Mac Cloud DB View page to locate specific records within the displayed data.

  • Input any value into the search device input box, and upon completion, the system will automatically initiate a search within the displayed data, retrieving the relevant record.

8

Saved View Filters

  • The Select View filter is a customized date or date range filter that has been previously saved using the save button.

  • To use this feature, click on the Select View filter dropdown, choose an option from the list, and the filter will be automatically applied.

  • The system automatically sets it to the Default filter if the user doesn't select any filter.

9

Save Filter Button

  • This button is for saving the custom date range filter for future use.

  • First, apply the custom date range explained above in the Enter a date range filter section. Then click on the save button. A pop-up will be populated with the title Save current filter state and an input field where we can give this filter a customized name. Then click the save button, which will save the customized filter.

  • This will add the new option at the top of the Select Filter dropdown list.

10

Filter Setting Button

  • This is a Custom filter edit and rename button.

  • This button has three main purposes: to change the orientation of the display data table columns and to rename the selected custom filter.

  • To utilize it, click on the settings button. A new popup window will open, containing three sections: visible columns, hidden columns, and Filter’s Rename.

  • The displayed data table columns will be shown in the Visible Columns section, and hidden columns will be shown in the Hidden Columns section.

  • The save button at the bottom of the popup window will update the selected custom filter with new changes.

  • The Delete button at the bottom of the popup window will delete the selected custom filter.

  • The Cancel button at the bottom of the popup window will close the popup window without any changes.

  • When the default filter is selected, the Save and Cancel buttons will appear in the popup window.

  • When the Custom filter is selected, the Delete, Cancel, and Save buttons will show in the popup window.

11

Reorder Columns

  • In this feature, we can change the order of the data table columns.

  • For utilization, open the setting, then drag up or down any column available in the visible columns list. Once you have reordered the columns, click the save button, and the columns in the data table will be reordered.

12

Visible or Hide Columns

  • In this feature, we can hide/unhide data table columns.

  • For utilization, open the setting, then drag any column from the Visible Columns section to the Hidden Columns section and vice versa.

  • Once you are done, click the save button. The columns in the data table will be Hidden or Unhide according to your settings.



​Troubleshooting or Reporting a Bug

1

Getting Started

  • The user should first collect the log file if an issue is reported. This will help the development team diagnose the issue.

    • Note - The log file is separate for PhoneCheck USB Cloner and the MacBook Diagnostics Application.

  • The Phonecheck development team will need a video that shows how the issue is reproduced to understand its cause fully.

  • Also, any pictures, serials, or other device information will help development in the investigation.

2

Collecting logs from Phonecheck USB Cloner

  • This will be present in the system from where the user is burning the USB. The system will create log files storing essential information, aiding in diagnosing issues and identifying patterns.

  • Open Finder → select Go To and enter the path for the PhoneCheck USB Cloner Logs: ~/Library/Application\ Support/PhonecheckCloner

  • An alternative method is to open Terminal on the computer and type: Open ~/Library/Application\ Support/PhonecheckCloner

  • Look for any log files that match the current file structure: ~/Library/Application\ Support/cloner/cloner_{current_date}.log

  • We store a maximum of 30 days of logs.

3

Collecting logs from Mac Diagnostics

  • On the upper left-hand corner of the MacCheck Diagnostic application, there will be a "Send Logs" Button.

  • Select that button and provide the following details to Customer Support

    1. Serial Number of the Mac with the issue

    2. Date and Time the "Send Logs" button was pressed.

Did this answer your question?