Configuration

There are two ways you can change the config of your scoreboard.

Using the nhl_setup app (recommended)

from the root of the nhl-led-scoreboard, run this command: ./nhl_setup. Please take a look at the documentation here: src/nhl_setup/README.md

Configuring manualy.

If you have no issue working with json files in a prompt, you can still configure manualy. FIRST, you will need to make a copy of the config.json.sample and rename it config.json. Then open it and modify the options.

Modes

These are options to set the scoreboard to run in a certain mode. This is where you enable the live game mode while will show the scoreboard of your favorite game when it's live.

Settings	Type	Parameters	Description
debug	Bool	true, false	Enable the debug mode which show on your console what the scoreboard
live_mode	Bool	true, false	Enable the live mode which show live game data of your favorite team.

Preferences

All the data related options.

Settings	Type	Parameters	Description
live_game_refresh_rate	INT	15	The rate at which a live game will call the NHL API to catch the new data. Do not go under 10 seconds as it's pointless and will affect your scoreboard performance.(Default 15 sec)
time_format	String	"12h" or "24h"	The format in which the game start time will be displayed.
end_of_day	String	"12:00"	A 24-hour time you wish to consider the end of the previous day before starting to display the current day's games.
location	String	"City,State/Province"	Location at which you would like to get weather updates. (Ex "Ottawa,ON")
teams	Array	["Canadiens", Blackhawks", "Avalanche"]	List of preferred teams. First one in the list is considered the favorite. If left empty, the scoreboard will be in "offday" mode
sog_display_frequency	INT	4	On data update frequency at which the Shots on goal stats appear while showing the scoreboard during a game. (Ex: the shots on goal will show every 4th data update)

Goal Animations

The goal animations can be set for both teams of just the preferred teams. MORE OPTIONS COMING SOON

Settings	Type	Parameters	Description
pref_team_only	Bool	true, false	self explanatory

Teams

For the teams parameters, only put the team's name. You can copy and paste your team's name from this table.

Team names	Team names
Avalanche	Jets
Blackhawks	Kings
Blues	Maple Leafs
Blue Jackets	Lightning
Bruins	Oilers
Canadiens	Panthers
Canucks	Penguins
Capitals	Predators
Coyotes	Rangers
Devils	Red Wings
Ducks	Sabres
Flames	Senators
Flyers	Sharks
Golden Knights	Stars
Hurricanes	Wild
Islanders

States

If the live mode is enabled, the scoreboard will go through different states depending on the current situation. For each state, you can define which of the available board you want the scoreboard to show. For example, if one of my preferred team has a game scheduled on the current day, during the day, the scoreboard will be in the scheduled state. I personally like to have all the data possible shown during the day so I'll set the all the boards in the scheduled setting.

Settings	Type	Parameters	Description
off_day, scheduled, intermission, post_game	Array	["scoreticker", team_summary", "standings", "clock", "covid_19]	List of preferred boards to show for each specific state.

Boards

Boards are essentially like pages on a website. Each of them shows something specific and the user can decide which board to display

depending on the state of the scoreboard. Currently, there are only three boards available:

• Score Ticker: This is basally like the generic score ticker you see during a game on TV of sports news showing the
• result or the status of the other games in the league.
• Standings: Self-explanatory, it shows the current standings. Currently, you can choose between showing standings by conference or by divisions. Wildcard standings are coming soon.
• Team Summary: Show a summary of your preferred teams. It includes data like standing record, Result of the previous game and the next scheduled game.
• Clock: Show the current time either in 24h or 12h format.
• Covid_19: Show the number of cases, deaths and recovered cases of the covid-19 virus in real time (API updates about every 15 min).

Boards	Settings	Type	Parameters	Description
scoreticker	preferred_teams_only	Bool	true, false	Choose between showing all the games of the day or just the ones your preferred teams are playing
	rotation_rate	INT	5	Duration at witch each games are shown on screen.
standings	preferred_standings_only	Bool	true, false	Choose between showing all the standings or only the the preferred division and conference.
	standing_type	String	conference, division , wild_card(Currently not available)	Option to choose the type of standings to display. conference if set by default.
	divisions	String	atlantic, metropolitan, central, pacific	Your preferred division
	conference	String	eastern, western	Your preferred conference
Clock	Duration	INT	15	The duration that the clock will be shown in Seconds
	hide_indicator	Bool	true, false	Show top green bar if there is a new update available.

Dimmer

The scoreboard can adjust the brightness of the matrix will running using the Dimmer function. By default, if enabled, the scoreboard software will detect your location using your IP address and will calculate the when the sun rise and the sun set. It will then use these moments to change the brightness of the screen depending on the parameters set in the config.

If you install the TSL2591 lux sensor, you can tell the scoreboard to use that to control the brightness instead.

Settings	Type	Parameters	Description
enabled	Bool	true, false	Enable the dimmer or not
source	String	"hardware", "software"	Select the source that controle the dimmer. If set to "software", the scoreboard will find your latitude and longitude based on your IP address. If an adafruit TSL2591 light sensor is connected to the Pi, you can set the source to "hardware" and let the sensor control the brightness.
light_level_lux	INT	400	This is the value you want the light sensor to start changing the brightness at
frequency	INT	5	Frequency at which the scoreboard will look if it needs to change the brightness
mode	String	"always", "offday"	Mode at which the dimmer will operate. If set at "always", the dimmer will operate at all time. at "offday", it will operate only when your preferred teams don't play any games.
sunset_brightness	INT	10	The brightness level (between 5 and 100) you want when it's night.
sunrise_brightness	INT	60	The brightness level (between 5 and 100) you want during the day.